EnvelopeDocumentFields Resource

The EnvelopeDocumentFields resource provides methods that allow you to manage custom fields on a document.

Custom fields are name-value pairs that are returned by the API but otherwise not used by Docusign. They are not seen by the envelope recipients.

Methods supported

Method	Description
create	POST `/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields` Creates custom document fields in an existing envelope document.
delete	DEL `/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields` Deletes custom document fields from an existing envelope document.
list	GET `/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields` Gets the custom document fields from an existing envelope document.
update	PUT `/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields` Updates existing custom document fields in an existing envelope document.

Property	Type	Description
`documentFields`	array	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.