Sign in
AccountCustomFields

Creates an account custom field.

This method creates a custom field and makes it available for all new envelopes associated with an account.

post/v2.1/accounts/{accountId}/custom_fields

Path parameters

accountIdstring required

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

Query parameters

apply_to_templatesstring

(Optional) When true, the new custom field is applied to all of the templates on the account.

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.

Changes

No recorded changes to this endpoint across all 39 revisions of this API.