Creates custom document fields in an existing envelope document
Creates custom document fields in an existing envelope document.
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 unique ID of the document within the envelope.
Unlike other IDs in the eSignature API,
you specify the documentId yourself.
Typically the first document has the ID
1, the second document 2, and so on,
but you can use any numbering scheme
that fits within a 32-bit signed integer
(1 through 2147483647).
Tab objects have a documentId property
that specifies the document on which to place
the tab.
The envelope's GUID.
Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
Request Body
application/json
Envelope document fields
The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by Docusign. The array contains the elements:
- name - A string that can be a maximum of 50 characters.
- value - A string that can be a maximum of 200 characters.
IMPORTANT: If you are using xml, the name/value pair is contained in a nameValue element.
Response Body
application/json
application/json
curl -X POST "https://example.com/v2.1/accounts/string/envelopes/string/documents/string/fields" \ -H "Content-Type: application/json" \ -d '{}'{ "documentFields": [ { "errorDetails": { "errorCode": "string", "message": "string" }, "name": "string", "originalValue": "string", "value": "string" } ]}