Creates an account custom field
This method creates a custom field and makes it available for all new envelopes associated with an account.
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
The external account number (int) or account ID GUID.
Query Parameters
(Optional) When true, the new custom field is applied to all of the templates on the account.
Request Body
application/json
This object provides details about a custom field.
The type of custom field. Valid values are:
text(default)list
This object describes errors that occur. It is only valid for responses and ignored in requests.
The ID of the custom field.
For a list custom field, this is an array of strings that represent the items in a list.
Maximum Length: 2,000 characters.
The name of the custom field.
When true, the signer must complete the custom field.
When true, the custom field displays at the top of the Certificate of Completion.
Specifies the value of the custom field.
Maximum Length: 2,000 characters.
Response Body
application/json
application/json
curl -X POST "https://example.com/v2.1/accounts/string/custom_fields" \ -H "Content-Type: application/json" \ -d '{}'{ "listCustomFields": [ { "configurationType": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "fieldId": "string", "listItems": [ "string" ], "name": "string", "required": "string", "show": "string", "value": "string" } ], "textCustomFields": [ { "configurationType": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "fieldId": "string", "name": "string", "required": "string", "show": "string", "value": "string" } ]}