Delete custom field
delete/v1/customField/deleteWith this API, users can easily delete a custom field by specifying the field ID, enabling seamless removal of unnecessary fields and maintaining an organized custom field collection.
Code snippet
curl --location --request DELETE 'https://api.boldsign.com/v1/customField/delete?customFieldId={customFieldId}' \ --header 'Accept: application/json;odata.metadata=minimal;odata.streaming=true' \ --header 'Authorization: {{apiKey}}'
var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Delete, "https://api.boldsign.com/v1/customField/delete?customFieldId=<string>"); request.Headers.Add("Accept", "application/json;odata.metadata=minimal;odata.streaming=true"); request.Headers.Add("Authorization", "{{apiKey}}"); var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());
import requests url = "https://api.boldsign.com/v1/customField/delete?customFieldId=<string>" payload = {} headers = { 'Accept': 'application/json;odata.metadata=minimal;odata.streaming=true', 'Authorization': '{{apiKey}}' } response = requests.request("DELETE", url, headers=headers, data=payload) print(response.text)
const axios = require('axios'); let config = { method: 'delete', maxBodyLength: Infinity, url: 'https://api.boldsign.com/v1/customField/delete?customFieldId=<string>', headers: { 'Accept': 'application/json;odata.metadata=minimal;odata.streaming=true', 'Authorization': '{{apiKey}}' } }; axios.request(config) .then((response) => { console.log(JSON.stringify(response.data)); }) .catch((error) => { console.log(error); });
Query parameters
customFieldIdstringRequired | The custom field Id obtained after successful custom field creation needs to be passed to delete the custom field. |
Example response
200 Success
{ "message": "Custom field deleted successfully." }