Updates envelope custom fields in an envelope
Updates the envelope custom fields in draft and in-process envelopes.
Each custom field used in an envelope must have a unique name.
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.
The envelope's GUID.
Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
Request Body
application/json
An envelope custom field enables you to collect custom data about envelopes on a per-envelope basis. You can then use the custom data for sorting, organizing, searching, and other downstream processes. For example, you can use custom fields to copy envelopes or data to multiple areas in Salesforce. eOriginal customers can eVault their documents from the web app on a per-envelope basis by setting an envelope custom field with a name like "eVault with eOriginal?" to "Yes" or "No".
When a user creates an envelope, the envelope custom fields display in the Envelope Settings section of the Docusign console. Envelope recipients do not see the envelope custom fields. For more information, see Envelope Custom Fields.
An array of list custom fields.
An array of text custom fields.
Response Body
application/json
application/json
curl -X PUT "https://example.com/v2.1/accounts/string/envelopes/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" } ]}