{"api":"esign_rest","category":"reference"}

Envelopes Category

The DocuSign API Envelope category includes the resources and methods for sending and managing envelopes and envelope data.

Envelopes are the key objects within the DocuSign eSignature system. As a result, they are complex data structures with few required fields. See the Code Examples for examples and solutions.

To learn more about envelopes, see Envelopes and Template.

EnvelopeCustomFields

Envelope custom fields

MethodDescription
list
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields

Gets the custom field information for the specified envelope.

update
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields

Updates envelope custom fields in an envelope.

create
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields

Updates envelope custom fields for an envelope.

delete
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields

Deletes envelope custom fields for draft and in-process envelopes.

EnvelopeDocumentFields

Envelope document fields

MethodDescription
list
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields

Gets the custom document fields from an existing envelope document.

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

Updates existing custom document fields in an existing envelope document.

create
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields

Creates custom document fields in an existing envelope document.

delete
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields

Deletes custom document fields from an existing envelope document.

EnvelopeLocks

Envelope locks

MethodDescription
get
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock

Gets envelope lock information.

update
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock

Updates an envelope lock.

create
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock

Lock an envelope.

delete
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock

Deletes an envelope lock.

EnvelopeRecipients

Envelope recipients

MethodDescription
list
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients

Gets the status of recipients for an envelope.

update
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients

Updates recipients in a draft envelope or corrects recipient information for an in process envelope.

create
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients

Adds one or more recipients to an envelope.

deleteList
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients

Deletes recipients from an envelope.

delete
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}

Deletes a recipient from an envelope.

EnvelopeRecipientTabs

All of the tabs associated with a recipient. Each property is a list of a type of tab.

MethodDescription
list
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs

Gets the tabs information for a signer or sign-in-person recipient in an envelope.

update
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs

Updates the tabs for a recipient.

create
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs

Adds tabs for a recipient.

delete
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs

Deletes the tabs associated with a recipient.

EnvelopeDocumentTabs

Envelope Document Tabs resource

MethodDescription
getByPage
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs

Returns tabs on the specified page.

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

Returns tabs on a document.

updateDocumentTabs
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs

createDocumentTabs
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs

deleteDocumentTabs
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs

EnvelopeViews

Embedding Envelope views

MethodDescription
createCorrect
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct

Returns a URL to the envelope correction UI.

createEdit
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/edit

Returns a URL to the edit view UI.

createRecipient
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient

Returns a URL to the recipient view UI.

createEnvelopeRecipientPreview
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview

createSender
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender

Returns a URL to the sender view UI.

createSharedRecipient
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared

createTemplateRecipientPreview
POST /v2.1/accounts/{accountId}/templates/{templateId}/views/recipient_preview

createConsole
POST /v2.1/accounts/{accountId}/views/console

Returns a URL to the authentication view UI.

EnvelopeConsumerDisclosures

Envelope consumer disclosures

MethodDescription
getDefault
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure

Gets the Electronic Record and Signature Disclosure associated with the account.

get
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}

Reserved: Gets the Electronic Record and Signature Disclosure associated with the account.

EnvelopeDocuments

Envelope documents

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

Gets a list of envelope documents.

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

Adds one or more documents to an existing envelope document.

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

Deletes documents from a draft envelope.

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

Gets a document from an envelope.

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

Adds a document to an existing draft envelope.

EnvelopeEmailSettings

Envelope email settings

MethodDescription
get
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings

Gets the email setting overrides for an envelope.

update
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings

Updates the email setting overrides for an envelope.

create
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings

Adds email setting overrides to an envelope.

delete
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings

Deletes the email setting overrides for an envelope.

Envelopes

Envelope creation, management

MethodDescription
listStatusChanges
GET /v2.1/accounts/{accountId}/envelopes

Gets status changes for one or more envelopes.

create
POST /v2.1/accounts/{accountId}/envelopes

Creates an envelope.

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

Gets the status of a single envelope.

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

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

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

Gets the envelope audit events for an envelope.

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

Returns document page image(s) based on input.

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

Deletes a page from a document in an envelope.

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

Gets a page image from an envelope for display.

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

Rotates page image from an envelope for display.

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

Gets envelope notification information.

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

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

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

Gets the initials image for a user.

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

Sets the initials image for an accountless signer.

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

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

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

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

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

Sets the signature image for an accountless signer.

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

Gets the envelope status for the specified envelopes.

EnvelopeTemplates

Envelope templates

MethodDescription
listByDocument
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates

Gets the templates associated with a document in an existing envelope.

applyToDocument
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates

Adds templates to a document in an envelope.

delete
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId}

Deletes a template from a document in an existing envelope.

list
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates

Get List of Templates used in an Envelope

apply
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates

Adds templates to an envelope.

EnvelopeAttachments

MethodDescription
list
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments

Returns a list of attachments associated with the specified envelope

create
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments

Add one or more attachments to a DRAFT or IN-PROCESS envelope.

delete
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments

Delete one or more attachments from a DRAFT envelope.

get
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}

Retrieves an attachment from the envelope.

update
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}

Add an attachment to a DRAFT or IN-PROCESS envelope.

ChunkedUploads

Chunked Uploads resource

MethodDescription
create
POST /v2.1/accounts/{accountId}/chunked_uploads

Initiate a new ChunkedUpload.

get
GET /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}

Retrieves the current metadata of a ChunkedUpload.

commit
PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}

Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.

delete
DELETE /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}

Delete an existing ChunkedUpload.

update
PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}

Add a chunk, a chunk 'part', to an existing ChunkedUpload.

EnvelopeFormData

MethodDescription
get
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data

Returns envelope form data for an existing envelope.

EnvelopeDocumentVisibility

MethodDescription
get
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility

Returns document visibility for the recipients

update
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility

Updates document visibility for the recipients

updateList
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility

Updates document visibility for the recipients

NotaryJournals

MethodDescription
list
GET /v2.1/current_user/notary/journals

EnvelopeDocumentHtmlDefinitions

MethodDescription
get
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions

DocumentResponsiveHtmlPreview

MethodDescription
create
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview

EnvelopeHtmlDefinitions

MethodDescription
list
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions

ResponsiveHtmlPreview

MethodDescription
create
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview

EnvelopeTransferRules

MethodDescription
getEnvelopeTransferRules
GET /v2.1/accounts/{accountId}/envelopes/transfer_rules

updateEnvelopeTransferRules
PUT /v2.1/accounts/{accountId}/envelopes/transfer_rules

createEnvelopeTransferRules
POST /v2.1/accounts/{accountId}/envelopes/transfer_rules

updateEnvelopeTransferRule
PUT /v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}

deleteEnvelopeTransferRules
DELETE /v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}

}} />