Delete custom field

delete/v1/customField/delete

With 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 boldsign

configuration = boldsign.Configuration(api_key="YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:
    
    custom_field_api = boldsign.CustomFieldApi(api_client)
    custom_field_api.delete_custom_field(custom_field_id="CUSTOM_FIELD_ID")
<?php require_once "vendor/autoload.php";

$config = new BoldSign\Configuration();
$config->setApiKey('YOUR_API_KEY');

$custom_field_api = new BoldSign\Api\CustomFieldApi($config);
$custom_field_api->deleteCustomField($custom_field_id = 'CUSTOM_FIELD_ID');
ApiClient client = Configuration.getDefaultApiClient();  
client.setApiKey("YOUR_API_KEY");
       
CustomFieldApi customFieldApi = new CustomFieldApi();
customFieldApi.deleteCustomField("CUSTOM_FIELD_ID");
import { CustomFieldApi } from "@boldsign/node-sdk";

const customFieldApi = new CustomFieldApi();
customFieldApi.setApiKey("YOUR_API_KEY");

customFieldApi.deleteCustomField("YOUR_CUSTOMFIELD_ID");

Query parameters

customFieldIdstringRequiredThe 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."
}