Skip to navigation

EnvelopeDocuments Resource

View as Markdown

The EnvelopeDocuments resource provides methods that manage documents in an envelope. You can:

  • add one or more documents to the envelope
  • retrieve one or more documents from the envelope
  • delete documents from the envelope

All of the methods in this resource operate on on an existing envelope. Before you can add documents to an envelope, you must first create it with the Envelopes: create method.

Methods supported

MethodDescription
deleteDEL /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/documents
Deletes documents from a draft envelope.
getGET /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}
Gets a document from an envelope.
listGET /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/documents
Gets a list of envelope documents.
updatePUT /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}
Adds a document to an existing draft envelope.
updateListPUT /restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/documents
Adds one or more documents to an existing envelope document.

EnvelopeDocuments properties

PropertyTypeDescription
envelopeDocumentsarray
envelopeIdstringThe envelope ID of the envelope status that failed to post.