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 -X DELETE 'https://api.boldsign.com/v1/customField/delete?customFieldId={customFieldId}' \
-H 'Accept: application/json;odata.metadata=minimal;odata.streaming=true' \
-H 'Authorization: {{apiKey}}'
var apiClient = new ApiClient("https://api.boldsign.com", "Your_API_Key");
var customFieldClient = new CustomFieldClient(apiClient);
customFieldClient.DeleteCustomField("CUSTOM_FIELD_ID");
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";
use BoldSign\Configuration;
use BoldSign\Api\CustomFieldApi;
$config = new Configuration();
$config->setApiKey('YOUR_API_KEY');
$custom_field_api = new CustomFieldApi($config);
$custom_field_api->deleteCustomField($custom_field_id = 'YOUR_CUSTOMFIELD_ID');
ApiClient client = Configuration.getDefaultApiClient();
client.setApiKey("YOUR_API_KEY");
CustomFieldApi customFieldApi = new CustomFieldApi(client);
customFieldApi.deleteCustomField("CUSTOM_FIELD_ID");
import { CustomFieldApi } from "boldsign";
const customFieldApi = new CustomFieldApi();
customFieldApi.setApiKey("YOUR_API_KEY");
customFieldApi.deleteCustomField("YOUR_CUSTOMFIELD_ID");
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."
}