> You are reading the Docusign Developer Documentation. For clean Markdown of any page, append .md to the page URL. > > Documentation indexes by section: > - APIs and SDKs: https://docusign.docs.buildwithfern.com/docs/llms.txt > - Platform 101: https://docusign.docs.buildwithfern.com/platform/llms.txt > - Extension Apps: https://docusign.docs.buildwithfern.com/extension-apps/llms.txt > - Docusign CLI: https://docusign.docs.buildwithfern.com/docusign-cli/llms.txt > > Authentication (OAuth, JWT Grant, M2M): https://docusign.docs.buildwithfern.com/platform/auth > Webhooks and Connect: https://docusign.docs.buildwithfern.com/platform/webhooks > > OpenAPI specifications: https://docusign.docs.buildwithfern.com/openapi.json > MCP server: https://docusign.docs.buildwithfern.com/_mcp/server # Envelopes Category 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](/docs/esign-rest-api/how-to) for examples and solutions. To learn more about envelopes, see [Envelopes](/docs/esign-rest-api/esign101/concepts/envelopes). ## [ChunkedUploads](/docs/esign-rest-api/reference/envelopes/chunkeduploads) **Description** The ChunkedUploads resource provides methods to complete integrity checks, and to add, commit, retrieve, initiate and delete chunked uploads. **Methods supported** * [commit](/docs/esign-rest-api/reference/envelopes/chunkeduploads/commit) * [create](/docs/esign-rest-api/reference/envelopes/chunkeduploads/create) * [delete](/docs/esign-rest-api/reference/envelopes/chunkeduploads/delete) * [get](/docs/esign-rest-api/reference/envelopes/chunkeduploads/get) * [update](/docs/esign-rest-api/reference/envelopes/chunkeduploads/update) ## [Comments](/docs/esign-rest-api/reference/envelopes/comments) **Description** Details about envelope comments. **Methods supported** * [get](/docs/esign-rest-api/reference/envelopes/comments/get) ## [DocumentGeneration](/docs/esign-rest-api/reference/envelopes/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** * [createArchiveMetadataEnvelopes](/docs/esign-rest-api/reference/envelopes/documentgeneration/createarchivemetadataenvelopes) * [createGenAndArchiveEnvelopes](/docs/esign-rest-api/reference/envelopes/documentgeneration/creategenandarchiveenvelopes) * [createGenAndConvertEnvelopes](/docs/esign-rest-api/reference/envelopes/documentgeneration/creategenandconvertenvelopes) * [createGenAndConvertMultiEnvelopes](/docs/esign-rest-api/reference/envelopes/documentgeneration/creategenandconvertmultienvelopes) * [createGenAndSendEnvelopes](/docs/esign-rest-api/reference/envelopes/documentgeneration/creategenandsendenvelopes) * [createLinkMetadataEnvelopes](/docs/esign-rest-api/reference/envelopes/documentgeneration/createlinkmetadataenvelopes) * [getEnvelopeDocGenFormFields](/docs/esign-rest-api/reference/envelopes/documentgeneration/getenvelopedocgenformfields) * [updateEnvelopeDocGenFormFields](/docs/esign-rest-api/reference/envelopes/documentgeneration/updateenvelopedocgenformfields) ## [DocumentResponsiveHtmlPreview](/docs/esign-rest-api/reference/envelopes/documentresponsivehtmlpreview) **Description** This resource is used to create a responsive preview of a specific document. **Methods supported** * [create](/docs/esign-rest-api/reference/envelopes/documentresponsivehtmlpreview/create) ## [EnvelopeAttachments](/docs/esign-rest-api/reference/envelopes/envelopeattachments) **Description** The EnvelopeAttachments resource provides methods that allow you to associate files with an envelope. **Methods supported** * [create](/docs/esign-rest-api/reference/envelopes/envelopeattachments/create) * [delete](/docs/esign-rest-api/reference/envelopes/envelopeattachments/delete) * [get](/docs/esign-rest-api/reference/envelopes/envelopeattachments/get) * [list](/docs/esign-rest-api/reference/envelopes/envelopeattachments/list) * [update](/docs/esign-rest-api/reference/envelopes/envelopeattachments/update) ## [EnvelopeConsumerDisclosures](/docs/esign-rest-api/reference/envelopes/envelopeconsumerdisclosures) **Description** Details about envelope consumer disclosures. **Methods supported** * [get](/docs/esign-rest-api/reference/envelopes/envelopeconsumerdisclosures/get) * [getDefault](/docs/esign-rest-api/reference/envelopes/envelopeconsumerdisclosures/getdefault) ## [EnvelopeCustomFields](/docs/esign-rest-api/reference/envelopes/envelopecustomfields) **Description** 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](https://support.docusign.com/s/document-item?bundleId=pik1583277475390\&topicId=qor1583277385137.html). **Methods supported** * [create](/docs/esign-rest-api/reference/envelopes/envelopecustomfields/create) * [delete](/docs/esign-rest-api/reference/envelopes/envelopecustomfields/delete) * [list](/docs/esign-rest-api/reference/envelopes/envelopecustomfields/list) * [update](/docs/esign-rest-api/reference/envelopes/envelopecustomfields/update) ## [EnvelopeDocumentFields](/docs/esign-rest-api/reference/envelopes/envelopedocumentfields) **Description** Envelope document fields **Methods supported** * [create](/docs/esign-rest-api/reference/envelopes/envelopedocumentfields/create) * [delete](/docs/esign-rest-api/reference/envelopes/envelopedocumentfields/delete) * [list](/docs/esign-rest-api/reference/envelopes/envelopedocumentfields/list) * [update](/docs/esign-rest-api/reference/envelopes/envelopedocumentfields/update) ## [EnvelopeDocumentHtmlDefinitions](/docs/esign-rest-api/reference/envelopes/envelopedocumenthtmldefinitions) **Methods supported** * [get](/docs/esign-rest-api/reference/envelopes/envelopedocumenthtmldefinitions/get) ## [EnvelopeDocuments](/docs/esign-rest-api/reference/envelopes/envelopedocuments) **Description** Envelope documents **Methods supported** * [delete](/docs/esign-rest-api/reference/envelopes/envelopedocuments/delete) * [get](/docs/esign-rest-api/reference/envelopes/envelopedocuments/get) * [getArchiveDocument](/docs/esign-rest-api/reference/envelopes/envelopedocuments/getarchivedocument) * [list](/docs/esign-rest-api/reference/envelopes/envelopedocuments/list) * [update](/docs/esign-rest-api/reference/envelopes/envelopedocuments/update) * [updateList](/docs/esign-rest-api/reference/envelopes/envelopedocuments/updatelist) ## [EnvelopeDocumentTabs](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs) **Description** Document tabs are tabs that are associated with a document rather than with a recipient. **Methods supported** * [create](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create) * [delete](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/delete) * [get](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/get) * [getByPage](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/getbypage) * [update](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/update) ## [EnvelopeDocumentVisibility](/docs/esign-rest-api/reference/envelopes/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](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980\&topicId=eui1578456411411.html). **Methods supported** * [get](/docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/get) * [update](/docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/update) * [updateRecipientsDocumentVisibility](/docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/updaterecipientsdocumentvisibility) ## [EnvelopeEmailSettings](/docs/esign-rest-api/reference/envelopes/envelopeemailsettings) **Description** Envelope email settings **Methods supported** * [create](/docs/esign-rest-api/reference/envelopes/envelopeemailsettings/create) * [delete](/docs/esign-rest-api/reference/envelopes/envelopeemailsettings/delete) * [get](/docs/esign-rest-api/reference/envelopes/envelopeemailsettings/get) * [update](/docs/esign-rest-api/reference/envelopes/envelopeemailsettings/update) ## [EnvelopeFormData](/docs/esign-rest-api/reference/envelopes/envelopeformdata) **Description** This object contains the data that recipients have entered into the form fields associated with an envelope. **Methods supported** * [get](/docs/esign-rest-api/reference/envelopes/envelopeformdata/get) ## [EnvelopeHtmlDefinitions](/docs/esign-rest-api/reference/envelopes/envelopehtmldefinitions) **Methods supported** * [list](/docs/esign-rest-api/reference/envelopes/envelopehtmldefinitions/list) ## [EnvelopeLocks](/docs/esign-rest-api/reference/envelopes/envelopelocks) **Description** Envelope locks let you lock an envelope to prevent any changes while you are updating an envelope. **Methods supported** * [create](/docs/esign-rest-api/reference/envelopes/envelopelocks/create) * [delete](/docs/esign-rest-api/reference/envelopes/envelopelocks/delete) * [get](/docs/esign-rest-api/reference/envelopes/envelopelocks/get) * [update](/docs/esign-rest-api/reference/envelopes/envelopelocks/update) ## [EnvelopePublish](/docs/esign-rest-api/reference/envelopes/envelopepublish) **Description** The EnvelopePublish resource allows you to submit existing envelopes to any webhook. **Methods supported** * [createHistoricalEnvelopePublishTransaction](/docs/esign-rest-api/reference/envelopes/envelopepublish/createhistoricalenvelopepublishtransaction) ## [EnvelopeRecipients](/docs/esign-rest-api/reference/envelopes/enveloperecipients) **Description** Envelope recipients **Methods supported** * [create](/docs/esign-rest-api/reference/envelopes/enveloperecipients/create) * [createEnvelopeRecipientPreview](/docs/esign-rest-api/reference/envelopes/enveloperecipients/createenveloperecipientpreview) * [createRecipientManualReviewView](/docs/esign-rest-api/reference/envelopes/enveloperecipients/createrecipientmanualreviewview) * [createRecipientProofFileResourceToken](/docs/esign-rest-api/reference/envelopes/enveloperecipients/createrecipientprooffileresourcetoken) * [delete](/docs/esign-rest-api/reference/envelopes/enveloperecipients/delete) * [deleteList](/docs/esign-rest-api/reference/envelopes/enveloperecipients/deletelist) * [list](/docs/esign-rest-api/reference/envelopes/enveloperecipients/list) * [update](/docs/esign-rest-api/reference/envelopes/enveloperecipients/update) ## [EnvelopeRecipientTabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs) **Description** All of the tabs associated with a recipient. Each property is a list of a type of tab. **Methods supported** * [create](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create) * [delete](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/delete) * [list](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/list) * [update](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/update) ## [Envelopes](/docs/esign-rest-api/reference/envelopes/envelopes) **Description** Envelope creation, management **Methods supported** * [create](/docs/esign-rest-api/reference/envelopes/envelopes/create) * [deleteDocumentPage](/docs/esign-rest-api/reference/envelopes/envelopes/deletedocumentpage) * [get](/docs/esign-rest-api/reference/envelopes/envelopes/get) * [getNotificationSettings](/docs/esign-rest-api/reference/envelopes/envelopes/getnotificationsettings) * [getPageImage](/docs/esign-rest-api/reference/envelopes/envelopes/getpageimage) * [getPageImages](/docs/esign-rest-api/reference/envelopes/envelopes/getpageimages) * [getRecipientInitialsImage](/docs/esign-rest-api/reference/envelopes/envelopes/getrecipientinitialsimage) * [getRecipientSignature](/docs/esign-rest-api/reference/envelopes/envelopes/getrecipientsignature) * [getRecipientSignatureImage](/docs/esign-rest-api/reference/envelopes/envelopes/getrecipientsignatureimage) * [listAuditEvents](/docs/esign-rest-api/reference/envelopes/envelopes/listauditevents) * [listStatus](/docs/esign-rest-api/reference/envelopes/envelopes/liststatus) * [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges) * [rotateDocumentPage](/docs/esign-rest-api/reference/envelopes/envelopes/rotatedocumentpage) * [update](/docs/esign-rest-api/reference/envelopes/envelopes/update) * [updateNotificationSettings](/docs/esign-rest-api/reference/envelopes/envelopes/updatenotificationsettings) * [updateRecipientInitialsImage](/docs/esign-rest-api/reference/envelopes/envelopes/updaterecipientinitialsimage) * [updateRecipientSignatureImage](/docs/esign-rest-api/reference/envelopes/envelopes/updaterecipientsignatureimage) ## [EnvelopeShares](/docs/esign-rest-api/reference/envelopes/envelopeshares) **Methods supported** * [createEnvelopesShares](/docs/esign-rest-api/reference/envelopes/envelopeshares/createenvelopesshares) * [deleteEnvelopesShare](/docs/esign-rest-api/reference/envelopes/envelopeshares/deleteenvelopesshare) * [deleteEnvelopesShares](/docs/esign-rest-api/reference/envelopes/envelopeshares/deleteenvelopesshares) * [getEnvelopesShare](/docs/esign-rest-api/reference/envelopes/envelopeshares/getenvelopesshare) * [getEnvelopesShares](/docs/esign-rest-api/reference/envelopes/envelopeshares/getenvelopesshares) * [getSharedEnvelopes](/docs/esign-rest-api/reference/envelopes/envelopeshares/getsharedenvelopes) * [updateEnvelopesShare](/docs/esign-rest-api/reference/envelopes/envelopeshares/updateenvelopesshare) * [updateEnvelopesShares](/docs/esign-rest-api/reference/envelopes/envelopeshares/updateenvelopesshares) ## [EnvelopeTemplates](/docs/esign-rest-api/reference/envelopes/envelopetemplates) **Description** Envelope templates **Methods supported** * [apply](/docs/esign-rest-api/reference/envelopes/envelopetemplates/apply) * [applyToDocument](/docs/esign-rest-api/reference/envelopes/envelopetemplates/applytodocument) * [delete](/docs/esign-rest-api/reference/envelopes/envelopetemplates/delete) * [list](/docs/esign-rest-api/reference/envelopes/envelopetemplates/list) * [listByDocument](/docs/esign-rest-api/reference/envelopes/envelopetemplates/listbydocument) ## [EnvelopeTransferRules](/docs/esign-rest-api/reference/envelopes/envelopetransferrules) **Description** This resource provides methods that enable account administrators to create and manage envelope transfer rules. **Methods supported** * [create](/docs/esign-rest-api/reference/envelopes/envelopetransferrules/create) * [delete](/docs/esign-rest-api/reference/envelopes/envelopetransferrules/delete) * [get](/docs/esign-rest-api/reference/envelopes/envelopetransferrules/get) * [update](/docs/esign-rest-api/reference/envelopes/envelopetransferrules/update) * [updateEnvelopeTransferRule](/docs/esign-rest-api/reference/envelopes/envelopetransferrules/updateenvelopetransferrule) ## [EnvelopeViews](/docs/esign-rest-api/reference/envelopes/envelopeviews) **Description** Provides a URL that you can embed in your application to provide access to the Docusign UI. ### Related topics * [Embedded signing and sending](/docs/esign-rest-api/esign101/concepts/embedding) * [Send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending) * [Introducing customizable embedded sending](https://www.docusign.com/blog/developers/introducing-customizable-embedded-sending) **Methods supported** * [createConsole](/docs/esign-rest-api/reference/envelopes/envelopeviews/createconsole) * [createCorrect](/docs/esign-rest-api/reference/envelopes/envelopeviews/createcorrect) * [createEdit](/docs/esign-rest-api/reference/envelopes/envelopeviews/createedit) * [createRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient) * [createSender](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsender) * [createSharedRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsharedrecipient) * [deleteEnvelopeCorrectView](/docs/esign-rest-api/reference/envelopes/envelopeviews/deleteenvelopecorrectview) ## [EnvelopeWorkflowDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition) **Description** Describes the workflow for an envelope or template. **Methods supported** * [createEnvelopeWorkflowStepDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/createenvelopeworkflowstepdefinition) * [createTemplateWorkflowStepDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/createtemplateworkflowstepdefinition) * [deleteEnvelopeDelayedRoutingDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/deleteenvelopedelayedroutingdefinition) * [deleteEnvelopeScheduledSendingDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/deleteenvelopescheduledsendingdefinition) * [deleteEnvelopeWorkflowDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/deleteenvelopeworkflowdefinition) * [deleteEnvelopeWorkflowStepDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/deleteenvelopeworkflowstepdefinition) * [deleteTemplateDelayedRoutingDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/deletetemplatedelayedroutingdefinition) * [deleteTemplateScheduledSendingDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/deletetemplatescheduledsendingdefinition) * [deleteTemplateWorkflowDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/deletetemplateworkflowdefinition) * [deleteTemplateWorkflowStepDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/deletetemplateworkflowstepdefinition) * [getEnvelopeDelayedRoutingDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/getenvelopedelayedroutingdefinition) * [getEnvelopeScheduledSendingDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/getenvelopescheduledsendingdefinition) * [getEnvelopeWorkflowDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/getenvelopeworkflowdefinition) * [getEnvelopeWorkflowStepDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/getenvelopeworkflowstepdefinition) * [getTemplateDelayedRoutingDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/gettemplatedelayedroutingdefinition) * [getTemplateScheduledSendingDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/gettemplatescheduledsendingdefinition) * [getTemplateWorkflowDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/gettemplateworkflowdefinition) * [getTemplateWorkflowStepDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/gettemplateworkflowstepdefinition) * [updateEnvelopeDelayedRoutingDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/updateenvelopedelayedroutingdefinition) * [updateEnvelopeScheduledSendingDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/updateenvelopescheduledsendingdefinition) * [updateEnvelopeWorkflowDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/updateenvelopeworkflowdefinition) * [updateEnvelopeWorkflowStepDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/updateenvelopeworkflowstepdefinition) * [updateTemplateDelayedRoutingDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/updatetemplatedelayedroutingdefinition) * [updateTemplateScheduledSendingDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/updatetemplatescheduledsendingdefinition) * [updateTemplateWorkflowDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/updatetemplateworkflowdefinition) * [updateTemplateWorkflowStepDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/updatetemplateworkflowstepdefinition) ## [NotaryJournals](/docs/esign-rest-api/reference/envelopes/notaryjournals) **Methods supported** * [list](/docs/esign-rest-api/reference/envelopes/notaryjournals/list) ## [ResponsiveHtmlPreview](/docs/esign-rest-api/reference/envelopes/responsivehtmlpreview) **Description** This resource is used to create a responsive preview of all of the documents in an envelope. **Methods supported** * [create](/docs/esign-rest-api/reference/envelopes/responsivehtmlpreview/create) ## [TabsBlob](/docs/esign-rest-api/reference/envelopes/tabsblob) **Description** Reserved for Docusign. **Methods supported** * [getTabsBlob](/docs/esign-rest-api/reference/envelopes/tabsblob/gettabsblob) * [putTabsBlob](/docs/esign-rest-api/reference/envelopes/tabsblob/puttabsblob)