Update envelope custom fields

PUT

/v2/accounts/:accountId/envelopes/:envelopeId/custom_fields

PUT

/restapi/v2/accounts/:accountId/envelopes/:envelopeId/custom_fields

curl -X PUT https://demo.docusign.net/restapi/v2/accounts/accountId/envelopes/envelopeId/custom_fields \
     -H "Authorization: <apiKey>" \
     -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"
    }
  ]
}

Updates the envelope custom fields in draft and in-process envelopes.

Each custom field used in an envelope must have a unique name.

Authentication

Authorizationstring

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token>.

Path parameters

accountIdstringRequired

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

envelopeIdstringRequired

The envelope’s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec

Request

This endpoint expects an object: EnvelopeCustomFields

listCustomFieldslist of objectsOptional

An array of list custom fields.

textCustomFieldslist of objectsOptional

An array of text custom fields.

Response

Successful response.

listCustomFieldslist of objectsOptional

An array of list custom fields.

textCustomFieldslist of objectsOptional

An array of text custom fields.

Errors

400

Bad Request Error