Envelopes Resource

The Envelope resource provides methods that allow you to manipulate and monitor envelopes.

Once you have authenticated the user you can use the Envelopes: createEnvelope method to create an envelope. You can call the EnvelopeDocuments: update or EnvelopeDocuments: updateList method to add additional documents.

Setting the status property on the envelope to sent allows you to send it or created to save it as a draft.

You can receive envelope event notifications by setting the eventNotification properties. When the envelope or recipient status changes to one of the specified status codes, a notification is sent to a URL that you specify.

If you have an envelope that you have previously saved, you can modify the subject and message, send it, void it, or place it in the purge queue using the Envelope: update method.

In addition to receiving notifications you can monitor the status of the envelopes using the following methods:

  • Envelope: getEnvelope - To get the status of a envelope.
  • Envelope: listStatus - To get the envelope status for a set of envelopes.
  • Envelope: listStatusChanges - To get status changes information for one or more envelopes.

If you need to delete a page from a document in an envelope, use the Envelope: deleteDocumentPage method.

The resource also includes a number of methods that allow you to retrieve and set the initials and signature for certain types of recipients on the document.

Methods

Method Description
create POST /v2/accounts/{accountId}/envelopes

Creates an envelope.

deleteDocumentPage DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}

Deletes a page from a document in an envelope.

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

Gets the status of a single envelope.

getNotificationSettings GET /v2/accounts/{accountId}/envelopes/{envelopeId}/notification

Gets envelope notification information.

getPageImage GET /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image

Gets a page image from an envelope for display.

getPageImages GET /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages

Returns document page image(s) based on input.

getRecipientInitialsImage GET /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image

Gets the initials image for a user.

getRecipientSignature GET /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature

Gets signature information for a signer or sign-in-person recipient.

getRecipientSignatureImage GET /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image

Retrieve signature image information for a signer/sign-in-person recipient.

listAuditEvents GET /v2/accounts/{accountId}/envelopes/{envelopeId}/audit_events

Gets the envelope audit events for an envelope.

listStatus PUT /v2/accounts/{accountId}/envelopes/status

Gets the envelope status for the specified envelopes.

listStatusChanges GET /v2/accounts/{accountId}/envelopes

Gets status changes for one or more envelopes.

rotateDocumentPage PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image

Rotates page image from an envelope for display.

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

Send, void, or modify a draft envelope. Purge documents from a completed envelope.

updateNotificationSettings PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/notification

Sets envelope notification (Reminders/Expirations) structure for an existing envelope.

updateRecipientInitialsImage PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image

Sets the initials image for an accountless signer.

updateRecipientSignatureImage PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image

Sets the signature image for an accountless signer.