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.
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:
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.
Gets status changes for one or more envelopes.
Creates an envelope.
Gets the status of a single envelope.
Send, void, or modify a draft envelope. Purge documents from a completed envelope.
Gets the envelope audit events for an envelope.
Returns document page image(s) based on input.
Deletes a page from a document in an envelope.
Gets a page image from an envelope for display.
Rotates page image from an envelope for display.
Gets envelope notification information.
Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
Gets the initials image for a user.
Sets the initials image for an accountless signer.
Gets signature information for a signer or sign-in-person recipient.
Retrieve signature image information for a signer/sign-in-person recipient.
Sets the signature image for an accountless signer.
Gets the envelope status for the specified envelopes.