Docusign Create Account Custom Field

The name of the custom field (required). This name will be used to identify the custom field throughout the account and in envelopes. Choose a descriptive name that clearly indicates the field's purpose.

When set to 'true', the custom field displays at the top of the Certificate of Completion. When set to 'false' or omitted, the field is not displayed. Accepts string values 'true' or 'false'.

The default value for the custom field. For text fields, this can be any string up to 2,000 characters. For list fields, this should match one of the items in the 'listItems' array to pre-select that option.

When set to 'true', the signer must complete this custom field before the envelope can be completed. When set to 'false' or omitted, the field is optional. Accepts string values 'true' or 'false'.

The unique identifier for the DocuSign account. This can be either the external account number (integer) or the account ID GUID. When not provided, the account ID from the authentication context will be used automatically.

Required when customFieldType is 'list'. An array of strings representing the selectable options in the dropdown list. Each item can be up to 2,000 characters. Example: ['Option A', 'Option B', 'Option C'].

The type of custom field to create. Valid values: 'text' (for text input fields) or 'list' (for dropdown selection fields). When using 'list', you must also provide the 'listItems' parameter. Defaults to 'text'.

When set to 'true', applies the newly created custom field to all existing templates in the account. When set to 'false' or omitted, the custom field will only be available for new envelopes. Accepts string values 'true' or 'false'.