Envelopes Category | Docusign

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

Envelopes are the key objects in the Docusign platform. As a result, they are complex data structures with few required fields. See the How-to guides for examples and solutions.

To learn more about envelopes, see Envelopes.

ChunkedUploads

Description

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

Methods supported

Comments

Description

Details about envelope comments.

Methods supported

DocumentGeneration

Description

Document Generation for eSignature allows you to dynamically generate documents from a Word template to send for signature within the eSignature sending workflow.

Methods supported

DocumentResponsiveHtmlPreview

Description

This resource is used to create a responsive preview of a specific document.

Methods supported

create

EnvelopeAttachments

Description

The EnvelopeAttachments resource provides methods that allow you to associate files with an envelope.

Methods supported

EnvelopeConsumerDisclosures

Description

Details about envelope consumer disclosures.

Methods supported

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. For more information, see Envelope Custom Fields.

Methods supported

EnvelopeDocumentFields

Description

Envelope document fields

Methods supported

EnvelopeDocumentHtmlDefinitions

Methods supported

EnvelopeDocuments

Description

Envelope documents

Methods supported

EnvelopeDocumentTabs

Description

Document tabs are tabs that are associated with a document rather than with a recipient.

Methods supported

EnvelopeDocumentVisibility

Description

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.

Methods supported