{"api":"esign_rest","category":"reference"}

EnvelopeDocumentFields Resource

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

You can create custom versions of standard fields that combine of field properties, such as font type or size, or a validation setting.

Note: Some advanced features and options are supported only in certain DocuSign plans. Your account plan might not support some options discussed in this help topic. For more information about which options are available for your account, check your account plan or contact your Account Manager.

MethodDescription
list
GET /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields

Retrieves the custom document field information from an existing envelope document.

update
PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields

Updates existing custom document fields in an existing envelope document.

create
POST /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields

Creates custom document fields in an existing envelope document.

delete
DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields

Deletes custom document fields from an existing envelope document.