Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
AccountCustomFields

Updates an account custom field.

This method updates an existing account custom field.

put/v2.1/accounts/{accountId}/custom_fields/{customFieldId}

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

customFieldIdstring required

The ID of the custom field.

Query parameters

apply_to_templatesstring

Request body

customFieldTypestring

The type of custom field. Valid values are:

  • text (default)
  • list
fieldIdstring

The ID of the custom field.

listItemsstring[]

For a list custom field, this is an array of strings that represent the items in a list.

Maximum Length: 2,000 characters.

namestring

The name of the custom field.

requiredstring

When true, the signer must complete the custom field.

showstring

When true, the custom field displays at the top of the Certificate of Completion.

valuestring

Specifies the value of the custom field.

Maximum Length: 2,000 characters.

Response

Successful response.