Update Custom Fields via API in Documents

Editing a custom field in the BoldSign API allows you to update the properties of an existing custom field associated with your brand. To edit a custom field using the BoldSign API, you will need to provide the updated field details, including the field's customFieldId , brandId and the new values for the properties you want to change.

Users can execute partial updates to a custom field by specifying only the fields they intend to modify. The API will modify the provided fields, leaving the remaining unchanged. However, if you want to edit values under the form field section, e.g for updating the fieldType you can specify as: "formField": {"fieldType": "CheckBox",} since it is a nested property.

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

Code snippet

curl -X POST \
  'https://api.boldsign.com/v1/customField/edit?customFieldId={customFieldId}' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: {your api key}' \
  -H 'Content-Type: application/json' \
  -d '{
    "fieldName": "PhoneNumber",
    "brandId": "{your brand Id}",
    "formField": {
      "fieldType": "TextBox",
      "width": 60,
      "height": 40,
      "isRequired": true,
      "validationType": "NumbersOnly"
    }
    }'

var apiClient = new ApiClient("https://api.boldsign.com", "API-KEY");

var customFieldClient = new CustomFieldClient(apiClient);

var updateCustomField = new UpdateCustomField()
{
    CustomFieldId = "{customFieldId}",
    FieldName = "MobileNumber",
    BrandId = "{your brandId}",
    formField: {
    fieldType: "TextBox",
        width: 60,
        height: 40,
        isRequired: true,
        validationType: "NumbersOnly"
    }
};

var response = await customFieldClient.EditAsync(updateCustomField);
Console.WriteLine(response);

import boldsign

configuration = boldsign.Configuration(host = "https://api.boldsign.com", api_key = "YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:

    custom_field_api = boldsign.CustomFieldApi(api_client)
    
    custom_form_field = boldsign.CustomFormField(
        fieldType = "TextBox",
        font = "Courier",
        width = 60,
        height = 60,        
        validationCustomRegex = "NumbersOnly",
        isRequired = True
    )
    
    custom_field_details = boldsign.BrandCustomFieldDetails(
        fieldName = "MobileNumber",
        fieldDescription = "Test custon field creation",
        fieldOrder = 1,
        brandId = "YOUR_BRAND_ID",
        formField = custom_form_field
    )  
    
    custom_field_message = custom_field_api.edit_custom_field(
        custom_field_id = "YOUR_CUSTOM_FIELD_ID",
        brand_custom_field_details = custom_field_details
    )

<?php require_once "vendor/autoload.php";

use BoldSign\Configuration;
use BoldSign\Api\CustomFieldApi;
use Boldsign\Model\{CustomFormField, BrandCustomFieldDetails};

$config = new Configuration();
$config->setHost("https://api.boldsign.com");
$config->setApiKey('YOUR_API_KEY');

$custom_field_api = new CustomFieldApi($config);

$custom_form_field = new CustomFormField();
$custom_form_field->setFieldType('TextBox');
$custom_form_field->setWidth(60);
$custom_form_field->setHeight(60);
$custom_form_field->setFont('Courier');
$custom_form_field->setIsRequired(true);
$custom_form_field->setValidationCustomRegex('NumbersOnly');

$custom_field_details = new BrandCustomFieldDetails();
$custom_field_details->setFieldName('MobileNumber');
$custom_field_details->setFieldDescription('Test custom field creation');
$custom_field_details->setFieldOrder(1);
$custom_field_details->setBrandId('YOUR_BRAND_ID');
$custom_field_details->setSharedField(true);
$custom_field_details->setFormField($custom_form_field);

$custom_field_message = $custom_field_api->editCustomField($custom_field_id = 'YOUR_CUSTOM_FIELD_ID', $custom_field_details);

ApiClient client = Configuration.getDefaultApiClient();
client.setBasePath("https://api.boldsign.com");
client.setApiKey("YOUR_API_KEY");

CustomFieldApi customFieldApi = new CustomFieldApi();

CustomFormField customFormField = new CustomFormField();
customFormField.setFieldType(CustomFormField.FieldTypeEnum.SIGNATURE);
customFormField.setWidth(60f);
customFormField.setHeight(60f);
customFormField.setIsRequired(true);
customFormField.setFont(CustomFormField.FontEnum.COURIER);
customFormField.setValidationCustomRegex("NumbersOnly");

BrandCustomFieldDetails customFieldDetails = new BrandCustomFieldDetails();
customFieldDetails.setFieldName("MobileNumber");
customFieldDetails.setFieldDescription("Test custon field creation");
customFieldDetails.setFieldOrder(1);
customFieldDetails.setBrandId("YOUR_BRAND_ID");
customFieldDetails.setSharedField(true);
customFieldDetails.setFormField(customFormField);

CustomFieldMessage customFieldMessage = customFieldApi.editCustomField("YOUR_CUSTOM_FIELD_ID", customFieldDetails);

import { CustomFieldApi, BrandCustomFieldDetails, CustomFormField } from "boldsign";

const customFieldApi = new CustomFieldApi("https://api.boldsign.com");
customFieldApi.setApiKey("YOUR_API_KEY");

const customFormField = new CustomFormField();
customFormField.fieldType = CustomFormField.FieldTypeEnum.TextBox;
customFormField.font = CustomFormField.FontEnum.Courier;
customFormField.width = 60;
customFormField.height = 60;
customFormField.isRequired = true;
customFormField.validationCustomRegex = "NumbersOnly";

const customFieldDetails = new BrandCustomFieldDetails();
customFieldDetails.fieldName = "MobileNumber";
customFieldDetails.fieldDescription = "Test custom field creation";
customFieldDetails.fieldOrder = 1;
customFieldDetails.brandId = "YOUR_BRAND_ID";
customFieldDetails.sharedField = true;
customFieldDetails.formField = customFormField;

const customFieldMessage = customFieldApi.editCustomField("YOUR_CUSTOM_FIELD_ID", customFieldDetails);

In the provided code example, provide the custom field values that you want to edit such as , such as fieldName, fieldDescription, fieldOrder and formField update with the new values. Replace the CustomId and brandId with your own values. When the above codes are executed, the custom field will be updated with the provided details.