DocuSign Momentum 2018DocuSign Momentum 2018
{"api":"esign_rest","category":"reference"}

EnvelopeDocuments Resource

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.

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

Retrieves a list of documents associated with the specified envelope.

updateList
PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/documents

Adds one or more documents to an existing envelope document.

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

Deletes one or more documents from an existing draft envelope.

get
GET /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}

Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted.

The {documentID} parameter takes two special values:

Value Description
combined Retrieve a PDF that contains the combined content of all documents and the certificate.
archive Retrieve a ZIP archive that contains all of the PDF documents, the certificate, and any .WAV files used for voice authentication.

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

Adds a document to an existing draft envelope.