{"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

An envelope custom field enables you to collect custom data about envelopes on a per-envelope basis. You can then use the custom data for sorting, organizing, searching, and other downstream processes. For example, you can use custom fields to copy envelopes or data to multiple areas in Salesforce. eOriginal customers can eVault their documents from the web app on a per-envelope basis by setting an envelope custom field with a name like "eVault with eOriginal?" to "Yes" or "No".

When a user creates an envelope, the envelope custom fields display in the Envelope Settings section of the DocuSign console. Envelope recipients do not see the envelope custom fields.

There are two types of envelope custom fields:

  • text: Enables the sender to enter the value for the field.
  • list: Enables the sender to select the value of the field from a predetermined list.

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

This section provides information about 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

Locks 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.

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

Creates an envelope recipient preview.

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 the tabs on a document.

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

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

delete
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.

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

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 notifications 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

The ChunkedUploads resource provides methods to complete integrity checks, and to add, commit, retrieve, initiate and delete chunked uploads.

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

Initiate a new chunked upload.

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

Retrieves metadata about a chunked upload.

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

Commit a chunked upload.

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

Deletes a chunked upload.

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

Add a chunk to an existing chunked upload.

EnvelopeFormData

This object contains the data that recipients have entered into the form fields associated with an envelope.

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

Returns envelope form data for an existing envelope.

EnvelopeDocumentVisibility

Document Visibility enables senders to control the visibility of the documents in an envelope at the recipient level. For example, if the parties associated with a legal proceeding should have access to different documents, the Document Visibility feature enables you to keep all of the documents in the same envelope and set view permissions for the documents by recipient. This functionality is enabled for envelopes and templates. It is not available for PowerForms.

Note: Before you use Document Visibility, you should be aware of the following information:

  • Document Visibility must be enabled for your account by your DocuSign administrator.
  • A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document.
  • When the Document Visibility setting hides a document from a recipient, the document also does not appear in the recipient's list of envelopes, documents, or page images.
  • Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template.

The Document Visibility feature has multiple settings that specify the options that senders have when sending documents. For more information, see Use Document Visibility to Control Recipient Access.

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

Returns document visibility for a recipient

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

Updates document visibility for a recipient

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

Updates document visibility for 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

This resource provides methods that enable account administrators to create and manage envelope transfer rules.

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

Gets envelope transfer rules.

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

Changes the status of multiple envelope transfer rules.

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

Creates an envelope transfer rule.

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

Changes the status of an envelope transfer rule.

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

Deletes an envelope transfer rule.

TabsBlob

MethodDescription
getTabsBlob
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob

putTabsBlob
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob

Comments

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

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

EnvelopeAppliance

MethodDescription
getApplianceInfo
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info

updateApplianceDocument
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/document/{documentId}

getDocumentPage
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/document_page_list

updatePageInfo
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/page_info

createPageInfo
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/page_info

deletePageInfo
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/page_info

getPdfBlob
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf_blobs

updatePdfBlob
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf_blobs

createPdfBlob
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf_blobs

updateRecipientDeniedDocumentCopy
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/recipient_denied_copy

getSignerAttachment
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/signer_attachment_info

updateSignerAttachment
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/signer_attachment_info

}} />