Update envelope custom fields

PUT

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

PUT

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

curl -X PUT https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/envelopes/ENVELOPE_ID/custom_fields \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "listCustomFields": [
    {
      "configurationType": "sample string 1",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      },
      "fieldId": "sample string 2",
      "listItems": [
        "sample string 1"
      ],
      "name": "sample string 3",
      "required": "sample string 4",
      "show": "sample string 5",
      "value": "sample string 6"
    }
  ],
  "textCustomFields": [
    {
      "configurationType": "sample string 1",
      "fieldId": "sample string 2",
      "name": "sample string 3",
      "required": "sample string 4",
      "show": "sample string 5",
      "value": "sample string 6"
    }
  ]
}'

{
  "listCustomFields": [
    {
      "configurationType": "sample string 1",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      },
      "fieldId": "sample string 2",
      "listItems": [
        "sample string 1"
      ],
      "name": "sample string 3",
      "required": "sample string 4",
      "show": "sample string 5",
      "value": "sample string 6"
    }
  ],
  "textCustomFields": [
    {
      "configurationType": "sample string 1",
      "fieldId": "sample string 2",
      "name": "sample string 3",
      "required": "sample string 4",
      "show": "sample string 5",
      "value": "sample string 6"
    }
  ]
}

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

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

Note: this method will return 200 OK even if some of the updates failed, make sure to check the errorDetails object every time you use this endpoint.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

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

envelopeIdstringRequired

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Request

This endpoint expects an object: customFields

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