Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
Account Custom Fields

Updates an account custom field

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

This method updates an existing account custom field.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

customFieldId*string

The ID of the custom field.

Query Parameters

apply_to_templates?string

Request Body

application/json

This object provides details about a custom field.

customFieldType?string

The type of custom field. Valid values are:

  • text (default)
  • list
errorDetails?

This object describes errors that occur. It is only valid for responses and ignored in requests.

fieldId?string

The ID of the custom field.

listItems?array<string>

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

Maximum Length: 2,000 characters.

name?string

The name of the custom field.

required?string

When true, the signer must complete the custom field.

show?string

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

value?string

Specifies the value of the custom field.

Maximum Length: 2,000 characters.

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/custom_fields/string" \  -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"    }  ]}

Deletes an account custom field DELETE

This method deletes an existing account custom field.

Gets the custom field information for the specified envelope GET

Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the Docusign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list. ### Related topics - [How to get envelope custom tab values](https://developers.docusign.com/docs/esign-rest-api/how-to/get-envelope-custom-tab-values/)