How to delete a custom field using BoldSign API?

When you no longer need a specific custom field, BoldSign allows you to delete it via API. To delete a custom field using the BoldSign API, you will need the customFieldId of the field you wish to remove. You can get the ID of the custom field by listing your custom fields using the API. Refer to this for listing custom fields

Below are examples of how to delete the created custom form field :

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' \
 -H 'X-API-KEY: {your api key}' \

   var apiClient = new ApiClient("https://api.boldsign.com", "{{apiKey}}");
   var customFieldClient = new CustomFieldClient(apiClient);
   var customFieldId = "your-custom-field-id";
   var deleteResponse = customFieldClient.DeleteCustomField(customFieldId);
   Console.WriteLine(deleteResponse);

import requests

url = "https://api.boldsign.com/v1/customField/delete?customFieldId=<string>"

payload = {}
headers = {
  'Accept': 'application/json;odata.metadata=minimal;odata.streaming=true',
    "X-API-KEY": "{your api key}"

}

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', 
    'X-API-KEY': '{your api key}'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});
<?php
require 'vendor/autoload.php'; 

use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;


$client = new GuzzleHttp\Client([ 'verify' => false, ]);

$apiKey = 'your_actual_api_key'; 
$customFieldId = 'your_custom_field_id'; 


$headers = [
    'Accept' => 'application/json;odata.metadata=minimal;odata.streaming=true',
   'X-API-KEY' => $apiKey, 
];

$requestUri = "https://api.boldsign.com/v1/customField/delete?customFieldId={$customFieldId}";

try {

    $request = new \GuzzleHttp\Psr7\Request('DELETE', $requestUri, $headers);


    $response = $client->sendAsync($request)->wait();

    echo $response->getBody();
} catch (RequestException $e) {

    echo 'Request failed: ' . $e->getMessage();
}


In the provided code example, make sure to replace values for customFieldId with the ID of the custom field that you want to delete. Once the codes are executed, the provided custom field will be permanently deleted from your account.