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.1/accounts/{accountId}/envelopes/{envelopeId}/documents
Deletes documents from a draft envelope.
getGET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}
Retrieves a single document or all documents from an envelope.
getArchiveDocumentGET /restapi/v2.1/accounts/{accountId}/archivedocuments/{documentId}
Return generated html document from archive.
listGET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents
Gets a list of documents in an envelope.
updatePUT /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}
Adds or replaces a document in an existing envelope.
updateListPUT /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents
Adds one or more documents to an existing envelope.

EnvelopeDocuments properties

PropertyTypeDescription
envelopeDocumentsarrayAn array of document objects.
envelopeIdstringThe envelope ID of the envelope status that failed to post.