EnvelopesApi (docusign-esign-java 3.9.0 API)

java.lang.Object
- com.docusign.esign.api.EnvelopesApi

public class EnvelopesApi
extends Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`EnvelopesApi.ApplyTemplateOptions`
`class`	`EnvelopesApi.ApplyTemplateToDocumentOptions`
`class`	`EnvelopesApi.CreateEnvelopeOptions`
`class`	`EnvelopesApi.CreateRecipientOptions`
`class`	`EnvelopesApi.GetChunkedUploadOptions`
`class`	`EnvelopesApi.GetCommentsTranscriptOptions`
`class`	`EnvelopesApi.GetConsumerDisclosureDefaultOptions`
`class`	`EnvelopesApi.GetConsumerDisclosureOptions`
`class`	`EnvelopesApi.GetDocumentOptions`
`class`	`EnvelopesApi.GetDocumentPageImageOptions`
`class`	`EnvelopesApi.GetDocumentTabsOptions`
`class`	`EnvelopesApi.GetEnvelopeOptions`
`class`	`EnvelopesApi.GetEnvelopeTransferRulesOptions`
`class`	`EnvelopesApi.GetPagesOptions`
`class`	`EnvelopesApi.GetRecipientInitialsImageOptions`
`class`	`EnvelopesApi.GetRecipientSignatureImageOptions`
`class`	`EnvelopesApi.ListDocumentsOptions`
`class`	`EnvelopesApi.ListRecipientsOptions`
`class`	`EnvelopesApi.ListStatusChangesOptions`
`class`	`EnvelopesApi.ListStatusOptions`
`class`	`EnvelopesApi.ListTabsOptions`
`class`	`EnvelopesApi.ListTemplatesForDocumentOptions`
`class`	`EnvelopesApi.ListTemplatesOptions`
`class`	`EnvelopesApi.UpdateChunkedUploadOptions`
`class`	`EnvelopesApi.UpdateOptions`
`class`	`EnvelopesApi.UpdateRecipientsOptions`

Constructor Summary

Constructors
Constructor and Description

EnvelopesApi()

EnvelopesApi(ApiClient apiClient)

Constructors
Constructor and Description
`EnvelopesApi()`
`EnvelopesApi(ApiClient apiClient)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentTemplateList`	`applyTemplate(String accountId, String envelopeId, DocumentTemplateList documentTemplateList)` Adds templates to an envelope.
`DocumentTemplateList`	`applyTemplate(String accountId, String envelopeId, DocumentTemplateList documentTemplateList, EnvelopesApi.ApplyTemplateOptions options)` Adds templates to an envelope.
`DocumentTemplateList`	`applyTemplateToDocument(String accountId, String envelopeId, String documentId, DocumentTemplateList documentTemplateList)` Adds templates to a document in an envelope.
`DocumentTemplateList`	`applyTemplateToDocument(String accountId, String envelopeId, String documentId, DocumentTemplateList documentTemplateList, EnvelopesApi.ApplyTemplateToDocumentOptions options)` Adds templates to a document in an envelope.
`ChunkedUploadResponse`	`createChunkedUpload(String accountId, ChunkedUploadRequest chunkedUploadRequest)` Initiate a new ChunkedUpload.
`ViewUrl`	`createConsoleView(String accountId, ConsoleViewRequest consoleViewRequest)` Returns a URL to the authentication view UI.
`ViewUrl`	`createCorrectView(String accountId, String envelopeId, CorrectViewRequest correctViewRequest)` Returns a URL to the envelope correction UI.
`CustomFields`	`createCustomFields(String accountId, String envelopeId, CustomFields customFields)` Updates envelope custom fields for an envelope.
`DocumentFieldsInformation`	`createDocumentFields(String accountId, String envelopeId, String documentId, DocumentFieldsInformation documentFieldsInformation)` Creates custom document fields in an existing envelope document.
`DocumentHtmlDefinitions`	`createDocumentResponsiveHtmlPreview(String accountId, String envelopeId, String documentId, DocumentHtmlDefinition documentHtmlDefinition)` Get Responsive HTML Preview for a document in an envelope.
`Tabs`	`createDocumentTabs(String accountId, String envelopeId, String documentId, Tabs tabs)` Adds the tabs to an envelope document
`ViewUrl`	`createEditView(String accountId, String envelopeId, ReturnUrlRequest returnUrlRequest)` Returns a URL to the edit view UI.
`EmailSettings`	`createEmailSettings(String accountId, String envelopeId, EmailSettings emailSettings)` Adds email setting overrides to an envelope.
`EnvelopeSummary`	`createEnvelope(String accountId, EnvelopeDefinition envelopeDefinition)` Creates an envelope.
`EnvelopeSummary`	`createEnvelope(String accountId, EnvelopeDefinition envelopeDefinition, EnvelopesApi.CreateEnvelopeOptions options)` Creates an envelope.
`CommentHistoryResult`	`createEnvelopeComments(String accountId, String envelopeId, CommentsPublish commentsPublish)` Posts a list of comments for authorized user
`ViewUrl`	`createEnvelopeRecipientPreview(String accountId, String envelopeId, RecipientPreviewRequest recipientPreviewRequest)` Provides a URL to start a recipient view of the Envelope UI
`ViewUrl`	`createEnvelopeRecipientSharedView(String accountId, String envelopeId, RecipientViewRequest recipientViewRequest)` Provides a URL to start a shared recipient view of the Envelope UI
`EnvelopeTransferRuleInformation`	`createEnvelopeTransferRules(String accountId, EnvelopeTransferRuleRequest envelopeTransferRuleRequest)` Add envelope transfer rules to an account.
`LockInformation`	`createLock(String accountId, String envelopeId, LockRequest lockRequest)` Lock an envelope.
`Recipients`	`createRecipient(String accountId, String envelopeId, Recipients recipients)` Adds one or more recipients to an envelope.
`Recipients`	`createRecipient(String accountId, String envelopeId, Recipients recipients, EnvelopesApi.CreateRecipientOptions options)` Adds one or more recipients to an envelope.
`ProofServiceViewLink`	`createRecipientProofFileLink(String accountId, String envelopeId, String recipientId)` Returns a link to access to the identity events stored in the proof service related to this recipient.
`ProofServiceResourceToken`	`createRecipientProofFileResourceToken(String tokenScopes, String accountId, String envelopeId, String recipientId)` Returns a resource token to get access to the identity events stored in the proof service related to this recipient.
`ViewUrl`	`createRecipientView(String accountId, String envelopeId, RecipientViewRequest recipientViewRequest)` Returns a URL to the recipient view UI.
`DocumentHtmlDefinitions`	`createResponsiveHtmlPreview(String accountId, String envelopeId, DocumentHtmlDefinition documentHtmlDefinition)` Get Responsive HTML Preview for all documents in an envelope.
`ViewUrl`	`createSenderView(String accountId, String envelopeId, ReturnUrlRequest returnUrlRequest)` Returns a URL to the sender view UI.
`Tabs`	`createTabs(String accountId, String envelopeId, String recipientId, Tabs tabs)` Adds tabs for a recipient.
`EnvelopeAttachmentsResult`	`deleteAttachments(String accountId, String envelopeId, EnvelopeAttachmentsRequest envelopeAttachmentsRequest)` Delete one or more attachments from a DRAFT envelope.
`ChunkedUploadResponse`	`deleteChunkedUpload(String accountId, String chunkedUploadId)` Delete an existing ChunkedUpload.
`CustomFields`	`deleteCustomFields(String accountId, String envelopeId, CustomFields customFields)` Deletes envelope custom fields for draft and in-process envelopes.
`DocumentFieldsInformation`	`deleteDocumentFields(String accountId, String envelopeId, String documentId, DocumentFieldsInformation documentFieldsInformation)` Deletes custom document fields from an existing envelope document.
`void`	`deleteDocumentPage(String accountId, String envelopeId, String documentId, String pageNumber)` Deletes a page from a document in an envelope.
`EnvelopeDocumentsResult`	`deleteDocuments(String accountId, String envelopeId, EnvelopeDefinition envelopeDefinition)` Deletes documents from a draft envelope.
`Tabs`	`deleteDocumentTabs(String accountId, String envelopeId, String documentId, Tabs tabs)` Deletes tabs from an envelope document
`EmailSettings`	`deleteEmailSettings(String accountId, String envelopeId)` Deletes the email setting overrides for an envelope.
`void`	`deleteEnvelopeCorrectView(String accountId, String envelopeId, CorrectViewRequest correctViewRequest)` Revokes the correction view URL to the Envelope UI
`void`	`deleteEnvelopeTransferRules(String accountId, String envelopeTransferRuleId)` Delete envelope transfer rules for an account.
`void`	`deleteEnvelopeWorkflowDefinition(String accountId, String envelopeId)` Delete the workflow definition for an envelope.
`LockInformation`	`deleteLock(String accountId, String envelopeId)` Deletes an envelope lock.
`Recipients`	`deleteRecipient(String accountId, String envelopeId, String recipientId)` Deletes a recipient from an envelope.
`Recipients`	`deleteRecipients(String accountId, String envelopeId, Recipients recipients)` Deletes recipients from an envelope.
`Tabs`	`deleteTabs(String accountId, String envelopeId, String recipientId, Tabs tabs)` Deletes the tabs associated with a recipient.
`void`	`deleteTemplatesFromDocument(String accountId, String envelopeId, String documentId, String templateId)` Deletes a template from a document in an existing envelope.
`void`	`deleteTemplateWorkflowDefinition(String accountId, String templateId)` Delete the workflow definition for a template.
`ApiClient`	`getApiClient()`
`void`	`getAttachment(String accountId, String envelopeId, String attachmentId)` Retrieves an attachment from the envelope.
`EnvelopeAttachmentsResult`	`getAttachments(String accountId, String envelopeId)` Returns a list of attachments associated with the specified envelope
`ChunkedUploadResponse`	`getChunkedUpload(String accountId, String chunkedUploadId)` Retrieves the current metadata of a ChunkedUpload.
`ChunkedUploadResponse`	`getChunkedUpload(String accountId, String chunkedUploadId, EnvelopesApi.GetChunkedUploadOptions options)` Retrieves the current metadata of a ChunkedUpload.
`byte[]`	`getCommentsTranscript(String accountId, String envelopeId)` Gets comment transcript for envelope and user
`byte[]`	`getCommentsTranscript(String accountId, String envelopeId, EnvelopesApi.GetCommentsTranscriptOptions options)` Gets comment transcript for envelope and user
`ConsumerDisclosure`	`getConsumerDisclosure(String accountId, String envelopeId, String recipientId, String langCode)` Reserved: Gets the Electronic Record and Signature Disclosure associated with the account.
`ConsumerDisclosure`	`getConsumerDisclosure(String accountId, String envelopeId, String recipientId, String langCode, EnvelopesApi.GetConsumerDisclosureOptions options)` Reserved: Gets the Electronic Record and Signature Disclosure associated with the account.
`ConsumerDisclosure`	`getConsumerDisclosureDefault(String accountId, String envelopeId, String recipientId)` Gets the Electronic Record and Signature Disclosure associated with the account.
`ConsumerDisclosure`	`getConsumerDisclosureDefault(String accountId, String envelopeId, String recipientId, EnvelopesApi.GetConsumerDisclosureDefaultOptions options)` Gets the Electronic Record and Signature Disclosure associated with the account.
`byte[]`	`getDocument(String accountId, String envelopeId, String documentId)` Gets a document from an envelope.
`byte[]`	`getDocument(String accountId, String envelopeId, String documentId, EnvelopesApi.GetDocumentOptions options)` Gets a document from an envelope.
`byte[]`	`getDocumentPageImage(String accountId, String envelopeId, String documentId, String pageNumber)` Gets a page image from an envelope for display.
`byte[]`	`getDocumentPageImage(String accountId, String envelopeId, String documentId, String pageNumber, EnvelopesApi.GetDocumentPageImageOptions options)` Gets a page image from an envelope for display.
`Tabs`	`getDocumentTabs(String accountId, String envelopeId, String documentId)` Returns tabs on the document.
`Tabs`	`getDocumentTabs(String accountId, String envelopeId, String documentId, EnvelopesApi.GetDocumentTabsOptions options)` Returns tabs on the document.
`EmailSettings`	`getEmailSettings(String accountId, String envelopeId)` Gets the email setting overrides for an envelope.
`Envelope`	`getEnvelope(String accountId, String envelopeId)` Gets the status of a envelope.
`Envelope`	`getEnvelope(String accountId, String envelopeId, EnvelopesApi.GetEnvelopeOptions options)` Gets the status of a envelope.
`DocumentHtmlDefinitionOriginals`	`getEnvelopeDocumentHtmlDefinitions(String accountId, String envelopeId, String documentId)` Get the Original HTML Definition used to generate the Responsive HTML for a given document.
`DocumentHtmlDefinitionOriginals`	`getEnvelopeHtmlDefinitions(String accountId, String envelopeId)` Get the Original HTML Definition used to generate the Responsive HTML for the envelope.
`EnvelopeTransferRuleInformation`	`getEnvelopeTransferRules(String accountId)` Returns a list of envelope transfer rules in the specified account.
`EnvelopeTransferRuleInformation`	`getEnvelopeTransferRules(String accountId, EnvelopesApi.GetEnvelopeTransferRulesOptions options)` Returns a list of envelope transfer rules in the specified account.
`Workflow`	`getEnvelopeWorkflowDefinition(String accountId, String envelopeId)` Returns the workflow definition for an envelope.
`EnvelopeFormData`	`getFormData(String accountId, String envelopeId)` Returns envelope form data for an existing envelope.
`LockInformation`	`getLock(String accountId, String envelopeId)` Gets envelope lock information.
`Notification`	`getNotificationSettings(String accountId, String envelopeId)` Gets envelope notification information.
`PageImages`	`getPages(String accountId, String envelopeId, String documentId)` Returns document page image(s) based on input.
`PageImages`	`getPages(String accountId, String envelopeId, String documentId, EnvelopesApi.GetPagesOptions options)` Returns document page image(s) based on input.
`Tabs`	`getPageTabs(String accountId, String envelopeId, String documentId, String pageNumber)` Returns tabs on the specified page.
`DocumentVisibilityList`	`getRecipientDocumentVisibility(String accountId, String envelopeId, String recipientId)` Returns document visibility for the recipients
`byte[]`	`getRecipientInitialsImage(String accountId, String envelopeId, String recipientId)` Gets the initials image for a user.
`byte[]`	`getRecipientInitialsImage(String accountId, String envelopeId, String recipientId, EnvelopesApi.GetRecipientInitialsImageOptions options)` Gets the initials image for a user.
`UserSignature`	`getRecipientSignature(String accountId, String envelopeId, String recipientId)` Gets signature information for a signer or sign-in-person recipient.
`byte[]`	`getRecipientSignatureImage(String accountId, String envelopeId, String recipientId)` Retrieve signature image information for a signer/sign-in-person recipient.
`byte[]`	`getRecipientSignatureImage(String accountId, String envelopeId, String recipientId, EnvelopesApi.GetRecipientSignatureImageOptions options)` Retrieve signature image information for a signer/sign-in-person recipient.
`void`	`getTabsBlob(String accountId, String envelopeId)` Get encrypted tabs for envelope.
`DocumentVisibilityList`	`getTemplateRecipientDocumentVisibility(String accountId, String templateId, String recipientId)` Returns document visibility for the recipients
`Workflow`	`getTemplateWorkflowDefinition(String accountId, String templateId)` Returns the workflow definition for a template.
`EnvelopeAuditEventResponse`	`listAuditEvents(String accountId, String envelopeId)` Gets the envelope audit events for an envelope.
`CustomFieldsEnvelope`	`listCustomFields(String accountId, String envelopeId)` Gets the custom field information for the specified envelope.
`DocumentFieldsInformation`	`listDocumentFields(String accountId, String envelopeId, String documentId)` Gets the custom document fields from an existing envelope document.
`EnvelopeDocumentsResult`	`listDocuments(String accountId, String envelopeId)` Gets a list of envelope documents.
`EnvelopeDocumentsResult`	`listDocuments(String accountId, String envelopeId, EnvelopesApi.ListDocumentsOptions options)` Gets a list of envelope documents.
`Recipients`	`listRecipients(String accountId, String envelopeId)` Gets the status of recipients for an envelope.
`Recipients`	`listRecipients(String accountId, String envelopeId, EnvelopesApi.ListRecipientsOptions options)` Gets the status of recipients for an envelope.
`EnvelopesInformation`	`listStatus(String accountId, EnvelopeIdsRequest envelopeIdsRequest)` Gets the envelope status for the specified envelopes.
`EnvelopesInformation`	`listStatus(String accountId, EnvelopeIdsRequest envelopeIdsRequest, EnvelopesApi.ListStatusOptions options)` Gets the envelope status for the specified envelopes.
`EnvelopesInformation`	`listStatusChanges(String accountId)` Gets status changes for one or more envelopes.
`EnvelopesInformation`	`listStatusChanges(String accountId, EnvelopesApi.ListStatusChangesOptions options)` Gets status changes for one or more envelopes.
`Tabs`	`listTabs(String accountId, String envelopeId, String recipientId)` Gets the tabs information for a signer or sign-in-person recipient in an envelope.
`Tabs`	`listTabs(String accountId, String envelopeId, String recipientId, EnvelopesApi.ListTabsOptions options)` Gets the tabs information for a signer or sign-in-person recipient in an envelope.
`TemplateInformation`	`listTemplates(String accountId, String envelopeId)` Get List of Templates used in an Envelope This returns a list of the server-side templates, their name and ID, used in an envelope.
`TemplateInformation`	`listTemplates(String accountId, String envelopeId, EnvelopesApi.ListTemplatesOptions options)` Get List of Templates used in an Envelope This returns a list of the server-side templates, their name and ID, used in an envelope.
`TemplateInformation`	`listTemplatesForDocument(String accountId, String envelopeId, String documentId)` Gets the templates associated with a document in an existing envelope.
`TemplateInformation`	`listTemplatesForDocument(String accountId, String envelopeId, String documentId, EnvelopesApi.ListTemplatesForDocumentOptions options)` Gets the templates associated with a document in an existing envelope.
`EnvelopeAttachmentsResult`	`putAttachment(String accountId, String envelopeId, String attachmentId, Attachment attachment)` Add an attachment to a DRAFT or IN-PROCESS envelope.
`EnvelopeAttachmentsResult`	`putAttachments(String accountId, String envelopeId, EnvelopeAttachmentsRequest envelopeAttachmentsRequest)` Add one or more attachments to a DRAFT or IN-PROCESS envelope.
`void`	`rotateDocumentPage(String accountId, String envelopeId, String documentId, String pageNumber, PageRequest pageRequest)` Rotates page image from an envelope for display.
`void`	`setApiClient(ApiClient apiClient)`
`EnvelopeUpdateSummary`	`update(String accountId, String envelopeId, Envelope envelope)` Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope.
`EnvelopeUpdateSummary`	`update(String accountId, String envelopeId, Envelope envelope, EnvelopesApi.UpdateOptions options)` Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope.
`ChunkedUploadResponse`	`updateChunkedUpload(String accountId, String chunkedUploadId)` Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.
`ChunkedUploadResponse`	`updateChunkedUpload(String accountId, String chunkedUploadId, EnvelopesApi.UpdateChunkedUploadOptions options)` Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.
`ChunkedUploadResponse`	`updateChunkedUploadPart(String accountId, String chunkedUploadId, String chunkedUploadPartSeq, ChunkedUploadRequest chunkedUploadRequest)` Add a chunk, a chunk 'part', to an existing ChunkedUpload.
`CustomFields`	`updateCustomFields(String accountId, String envelopeId, CustomFields customFields)` Updates envelope custom fields in an envelope.
`EnvelopeDocument`	`updateDocument(String accountId, String envelopeId, String documentId)` Adds a document to an existing draft envelope.
`DocumentFieldsInformation`	`updateDocumentFields(String accountId, String envelopeId, String documentId, DocumentFieldsInformation documentFieldsInformation)` Updates existing custom document fields in an existing envelope document.
`EnvelopeDocumentsResult`	`updateDocuments(String accountId, String envelopeId, EnvelopeDefinition envelopeDefinition)` Adds one or more documents to an existing envelope document.
`Tabs`	`updateDocumentTabs(String accountId, String envelopeId, String documentId, Tabs tabs)` Updates the tabs for an envelope document
`EmailSettings`	`updateEmailSettings(String accountId, String envelopeId, EmailSettings emailSettings)` Updates the email setting overrides for an envelope.
`EnvelopeTransferRule`	`updateEnvelopeTransferRule(String accountId, String envelopeTransferRuleId, EnvelopeTransferRule envelopeTransferRule)` Update an envelope transfer rule for an account.
`EnvelopeTransferRuleInformation`	`updateEnvelopeTransferRules(String accountId, EnvelopeTransferRuleInformation envelopeTransferRuleInformation)` Update envelope transfer rules for an account.
`Workflow`	`updateEnvelopeWorkflowDefinition(String accountId, String envelopeId, Workflow workflow)` Updates the envelope workflow definition for an envelope.
`LockInformation`	`updateLock(String accountId, String envelopeId, LockRequest lockRequest)` Updates an envelope lock.
`Notification`	`updateNotificationSettings(String accountId, String envelopeId, EnvelopeNotificationRequest envelopeNotificationRequest)` Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
`DocumentVisibilityList`	`updateRecipientDocumentVisibility(String accountId, String envelopeId, String recipientId, DocumentVisibilityList documentVisibilityList)` Updates document visibility for the recipients
`void`	`updateRecipientInitialsImage(String accountId, String envelopeId, String recipientId)` Sets the initials image for an accountless signer.
`RecipientsUpdateSummary`	`updateRecipients(String accountId, String envelopeId, Recipients recipients)` Updates recipients in a draft envelope or corrects recipient information for an in process envelope.
`RecipientsUpdateSummary`	`updateRecipients(String accountId, String envelopeId, Recipients recipients, EnvelopesApi.UpdateRecipientsOptions options)` Updates recipients in a draft envelope or corrects recipient information for an in process envelope.
`DocumentVisibilityList`	`updateRecipientsDocumentVisibility(String accountId, String envelopeId, DocumentVisibilityList documentVisibilityList)` Updates document visibility for the recipients
`void`	`updateRecipientSignatureImage(String accountId, String envelopeId, String recipientId)` Sets the signature image for an accountless signer.
`Tabs`	`updateTabs(String accountId, String envelopeId, String recipientId, Tabs tabs)` Updates the tabs for a recipient.
`void`	`updateTabsBlob(String accountId, String envelopeId)` Update encrypted tabs for envelope.
`TemplateDocumentVisibilityList`	`updateTemplateRecipientDocumentVisibility(String accountId, String templateId, String recipientId, TemplateDocumentVisibilityList templateDocumentVisibilityList)` Updates document visibility for the recipients
`TemplateDocumentVisibilityList`	`updateTemplateRecipientsDocumentVisibility(String accountId, String templateId, TemplateDocumentVisibilityList templateDocumentVisibilityList)` Updates document visibility for the recipients
`Workflow`	`updateTemplateWorkflowDefinition(String accountId, String templateId, Workflow workflow)` Updates the workflow definition for a template.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EnvelopesApi
```
public EnvelopesApi()
```
  - EnvelopesApi
```
public EnvelopesApi(ApiClient apiClient)
```
- Method Detail
  - getApiClient
```
public ApiClient getApiClient()
```
  - setApiClient
```
public void setApiClient(ApiClient apiClient)
```
  - applyTemplate
```
public DocumentTemplateList applyTemplate(String accountId,
                                          String envelopeId,
                                          DocumentTemplateList documentTemplateList)
                                   throws ApiException
```
    Adds templates to an envelope. Adds templates to the specified envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentTemplateList - (optional)
    
    Returns:
    
    DocumentTemplateList
    
    Throws:
    
    ApiException
  - applyTemplate
```
public DocumentTemplateList applyTemplate(String accountId,
                                          String envelopeId,
                                          DocumentTemplateList documentTemplateList,
                                          EnvelopesApi.ApplyTemplateOptions options)
                                   throws ApiException
```
    Adds templates to an envelope. Adds templates to the specified envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentTemplateList - (optional)
    
    options - for modifying the method behavior.
    
    Returns:
    
    DocumentTemplateList
    
    Throws:
    
    ApiException - if fails to make API call
  - applyTemplateToDocument
```
public DocumentTemplateList applyTemplateToDocument(String accountId,
                                                    String envelopeId,
                                                    String documentId,
                                                    DocumentTemplateList documentTemplateList)
                                             throws ApiException
```
    Adds templates to a document in an envelope. Adds templates to a document in the specified envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    documentTemplateList - (optional)
    
    Returns:
    
    DocumentTemplateList
    
    Throws:
    
    ApiException
  - applyTemplateToDocument
```
public DocumentTemplateList applyTemplateToDocument(String accountId,
                                                    String envelopeId,
                                                    String documentId,
                                                    DocumentTemplateList documentTemplateList,
                                                    EnvelopesApi.ApplyTemplateToDocumentOptions options)
                                             throws ApiException
```
    Adds templates to a document in an envelope. Adds templates to a document in the specified envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    documentTemplateList - (optional)
    
    options - for modifying the method behavior.
    
    Returns:
    
    DocumentTemplateList
    
    Throws:
    
    ApiException - if fails to make API call
  - createChunkedUpload
```
public ChunkedUploadResponse createChunkedUpload(String accountId,
                                                 ChunkedUploadRequest chunkedUploadRequest)
                                          throws ApiException
```
    Initiate a new ChunkedUpload.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    chunkedUploadRequest - (optional)
    
    Returns:
    
    ChunkedUploadResponse
    
    Throws:
    
    ApiException - if fails to make API call
  - createConsoleView
```
public ViewUrl createConsoleView(String accountId,
                                 ConsoleViewRequest consoleViewRequest)
                          throws ApiException
```
    Returns a URL to the authentication view UI. Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    consoleViewRequest - (optional)
    
    Returns:
    
    ViewUrl
    
    Throws:
    
    ApiException - if fails to make API call
  - createCorrectView
```
public ViewUrl createCorrectView(String accountId,
                                 String envelopeId,
                                 CorrectViewRequest correctViewRequest)
                          throws ApiException
```
    Returns a URL to the envelope correction UI. Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    correctViewRequest - (optional)
    
    Returns:
    
    ViewUrl
    
    Throws:
    
    ApiException - if fails to make API call
  - createCustomFields
```
public CustomFields createCustomFields(String accountId,
                                       String envelopeId,
                                       CustomFields customFields)
                                throws ApiException
```
    Updates envelope custom fields for an envelope. Updates the envelope custom fields for draft and in-process envelopes. Each custom field used in an envelope must have a unique name.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    customFields - (optional)
    
    Returns:
    
    CustomFields
    
    Throws:
    
    ApiException - if fails to make API call
  - createDocumentFields
```
public DocumentFieldsInformation createDocumentFields(String accountId,
                                                      String envelopeId,
                                                      String documentId,
                                                      DocumentFieldsInformation documentFieldsInformation)
                                               throws ApiException
```
    Creates custom document fields in an existing envelope document. Creates custom document fields in an existing envelope document.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    documentFieldsInformation - (optional)
    
    Returns:
    
    DocumentFieldsInformation
    
    Throws:
    
    ApiException - if fails to make API call
  - createDocumentResponsiveHtmlPreview
```
public DocumentHtmlDefinitions createDocumentResponsiveHtmlPreview(String accountId,
                                                                   String envelopeId,
                                                                   String documentId,
                                                                   DocumentHtmlDefinition documentHtmlDefinition)
                                                            throws ApiException
```
    Get Responsive HTML Preview for a document in an envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    documentHtmlDefinition - (optional)
    
    Returns:
    
    DocumentHtmlDefinitions
    
    Throws:
    
    ApiException - if fails to make API call
  - createDocumentTabs
```
public Tabs createDocumentTabs(String accountId,
                               String envelopeId,
                               String documentId,
                               Tabs tabs)
                        throws ApiException
```
    Adds the tabs to an envelope document
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    tabs - (optional)
    
    Returns:
    
    Tabs
    
    Throws:
    
    ApiException - if fails to make API call
  - createEditView
```
public ViewUrl createEditView(String accountId,
                              String envelopeId,
                              ReturnUrlRequest returnUrlRequest)
                       throws ApiException
```
    Returns a URL to the edit view UI. Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    returnUrlRequest - (optional)
    
    Returns:
    
    ViewUrl
    
    Throws:
    
    ApiException - if fails to make API call
  - createEmailSettings
```
public EmailSettings createEmailSettings(String accountId,
                                         String envelopeId,
                                         EmailSettings emailSettings)
                                  throws ApiException
```
    Adds email setting overrides to an envelope. Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made. ### Important: The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    emailSettings - (optional)
    
    Returns:
    
    EmailSettings
    
    Throws:
    
    ApiException - if fails to make API call
  - createEnvelope
```
public EnvelopeSummary createEnvelope(String accountId,
                                      EnvelopeDefinition envelopeDefinition)
                               throws ApiException
```
    Creates an envelope. Creates an envelope. Using this function you can: * Create an envelope and send it. * Create an envelope from an existing template and send it. In either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the request's `status` property to `created` instead of `sent`. ## Sending Envelopes Documents can be included with the Envelopes::create call itself or a template can include documents. Documents can be added by using a multi-part/form request or by using the `documentBase64` field of the [`document` object](#/definitions/document) ### Recipient Types An [`envelopeDefinition` object](#/definitions/envelopeDefinition) is used as the method's body. Envelope recipients can be defined in the envelope or in templates. The `envelopeDefinition` object's `recipients` field is an [`EnvelopeRecipients` resource object](#/definitions/EnvelopeRecipients). It includes arrays of the seven types of recipients defined by DocuSign: Recipient type | Object definition -------------- | ----------------- agent (can add name and email information for later recipients/signers) | [`agent`](#/definitions/agent) carbon copy (receives a copy of the documents) | [`carbonCopy`](#/definitions/carbonCopy) certified delivery (receives a copy of the documents and must acknowledge receipt) | [`certifiedDelivery`](#/definitions/certifiedDelivery) editor (can change recipients and document fields for later recipients/signers) | [`editor`](#/definitions/editor) in-person signer (\"hosts\" someone who signs in-person) | [`inPersonSigner`](#/definitions/inPersonSigner) intermediary (can add name and email information for some later recipients/signers.) | [`intermediary`](#/definitions/intermediary) signer (signs and/or updates document fields) | [`signer`](#/definitions/signer) Additional information about the different types of recipients is available from the [`EnvelopeRecipients` resource page](../../EnvelopeRecipients) and from the [Developer Center](https://www.docusign.com/developer-center/explore/features/recipients) ### Tabs Tabs (also referred to as `tags` and as `fields` in the web sending user interface), can be defined in the `envelopeDefinition`, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below). Defining tabs: the `inPersonSigner`, and `signer` recipient objects include a `tabs` field. It is an [`EnvelopeTabs` resource object](#/definitions/EnvelopeTabs). It includes arrays of the 24 different tab types available. See the [`EnvelopeTabs` resource](../../EnvelopeTabs) for more information. ## Using Templates Envelopes use specific people or groups as recipients. Templates can specify a role, eg `account_manager.` When a template is used in an envelope, the roles must be replaced with specific people or groups. When you create an envelope using a `templateId`, the different recipient type objects within the [`EnvelopeRecipients` object](#/definitions/EnvelopeRecipients) are used to assign recipients to the template's roles via the `roleName` property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template. ### Message Lock When a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The field `messageLock` is used to lock the email subject and message. If an email subject or message is entered before adding or applying a template with `messageLock` **true**, the email subject and message is overwritten with the locked email subject and message from the template. ## Envelope Status The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope's status changes. DocuSign limits polling to once every 15 minutes or less frequently. When a webhook is used, DocuSign calls your application, via the URL you provide, with a notification XML message. See the [Webhook recipe](https://www.docusign.com/developer-center/recipes/webhook-status) for examples and live demos of using webhooks. ## Webhook Options The two webhook options, *eventNotification* and *Connect* use the same notification mechanism and message formats. eventNotification is used to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client. ### eventNotification Webhooks The Envelopes::create method includes an optional [eventNotification object](#definition-eventNotification) that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access. ### Connect Webhooks Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or via other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc. Connect configurations may be created and managed using the [ConnectConfigurations resource](../../Connect/ConnectConfigurations). Configurations can also be created and managed from the Administration tool accessed by selecting \"Go to Admin\" from the menu next to your picture on the DocuSign web app. See the Integrations/Connect section of the Admin tool. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs. Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information. ## Composite Templates The Composite Templates feature, like [compositing in film production](https://en.wikipedia.org/wiki/Compositing), enables you to *overlay* document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more. Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents. * The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multi-part HTTP message. If used, the document content-disposition must include the `compositeTemplateId` to which the document should be added. If `compositeTemplateId` is not specified in the content-disposition, the document is applied based on the `documentId` only. If no document object is specified, the composite template inherits the first document. * Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value. * Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value. * Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the *first* document it finds from a server template or inline template, starting with the lowest sequence value. PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set `transformPdfFields` to \"true\" for the document. See the Transform PDF Fields section for more information about process. * PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat's XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value. ### Compositing the definitions Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied: * Templates are overlaid in the order of their Sequence value. * If Document is not passed into the Composite Template's `document` field, the *first* template's document (based on the template's Sequence value) is used. * Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing. For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) then where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template then where that role recipient is specified. * Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order. * If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput. * Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents. For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations. * roleName and tabLabel matching is case sensitive. * The defaultRecipient field enables you to specify which recipient the generated tabs from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the DefaultRecipient by specifying the mapping of the tab label that is created to one of the template recipients. * You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with \"\\*\" and then the system matches tabs that start with the label. * If no DefaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.) ### Including the Document Content for Composite Templates Document content can be supplied inline, using the `documentBase64` or can be included in a multi-part HTTP message. If a multi-part message is used and there are multiple Composite Templates, the document content-disposition can include the `compositeTemplateId` to which the document should be added. Using the `compositeTemplateId` sets which documents are associated with particular composite templates. An example of this usage is: ``` --5cd3320a-5aac-4453-b3a4-cbb52a4cba5d Content-Type: application/pdf Content-Disposition: file; filename=\"eula.pdf\"; documentId=1; compositeTemplateId=\"1\" Content-Transfer-Encoding: base64 ``` ### PDF Form Field Transformation Only the following PDF Form FieldTypes will be transformed to DocuSign tabs: CheckBox, DateTime, ListBox, Numeric, Password, Radio, Signature, and Text Field Properties that will be transformed: Read Only, Required, Max Length, Positions, and Initial Data. When transforming a *PDF Form Digital Signature Field,* the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be ------- | -------- DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab When transforming *PDF Form Text Fields,* the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be ------- | -------- DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials DocuSignEnvelopeID or eSignEnvelopeID | EnvelopeID DocuSignCompany or eSignCompany | Company DocuSignDateSigned or eSignDateSigned | Date Signed DocuSignTitle or eSignTitle | Title DocuSignFullName or eSignFullName | Full Name DocuSignSignerAttachmentOptional or eSignSignerAttachmentOptional | Optional Signer Attachment Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab. PDF Form Field Names that include \"DocuSignIgnoreTransform\" or \"eSignIgnoreTransform\" will not be transformed. PDF Form Date fields will be transformed to Date Signed fields if their name includes DocuSignDateSigned or eSignDateSigned. ## Template Email Subject Merge Fields This feature enables you to insert recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient's `roleName`, are added to the `emailSubject` when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. * To add a recipient's name in the subject line add the following text in the `emailSubject` when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `\"emailSubject\":\"[[Signer 1_UserName]], Please sign this NDA\",` * To add a recipient's email address in the subject line add the following text in the emailSubject when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `\"emailSubject\":\"[[Signer 1_Email]], Please sign this NDA\",` In both cases the <roleName> is the recipient's `roleName` in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject. ## Branding an envelope The following rules are used to determine the `brandId` used in an envelope: * If a `brandId` is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. * If more than one template is used in an envelope and more than one `brandId` is specified, the first `brandId` specified is used throughout the envelope. * In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the account's default signing brand is used. * For envelopes that do not meet any of the previous criteria, the account's default signing brand is used for the envelope. ## BCC Email address feature The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, don't use the BCC Email field. Use a Carbon Copy or Certified Delivery Recipient type. ## Merge Recipient Roles for Draft Envelopes When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could cause leave duplicate recipients in the envelope. To prevent this, the query parameter `merge_roles_on_draft` should be added when posting a draft envelope (status=created) with multiple templates. Doing this will merge template roles and remove empty recipients. ###### Note: DocuSign recommends that the `merge_roles_on_draft` query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeDefinition - (optional)
    
    Returns:
    
    EnvelopeSummary
    
    Throws:
    
    ApiException
  - createEnvelope
```
public EnvelopeSummary createEnvelope(String accountId,
                                      EnvelopeDefinition envelopeDefinition,
                                      EnvelopesApi.CreateEnvelopeOptions options)
                               throws ApiException
```
    Creates an envelope. Creates an envelope. Using this function you can: * Create an envelope and send it. * Create an envelope from an existing template and send it. In either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the request's `status` property to `created` instead of `sent`. ## Sending Envelopes Documents can be included with the Envelopes::create call itself or a template can include documents. Documents can be added by using a multi-part/form request or by using the `documentBase64` field of the [`document` object](#/definitions/document) ### Recipient Types An [`envelopeDefinition` object](#/definitions/envelopeDefinition) is used as the method's body. Envelope recipients can be defined in the envelope or in templates. The `envelopeDefinition` object's `recipients` field is an [`EnvelopeRecipients` resource object](#/definitions/EnvelopeRecipients). It includes arrays of the seven types of recipients defined by DocuSign: Recipient type | Object definition -------------- | ----------------- agent (can add name and email information for later recipients/signers) | [`agent`](#/definitions/agent) carbon copy (receives a copy of the documents) | [`carbonCopy`](#/definitions/carbonCopy) certified delivery (receives a copy of the documents and must acknowledge receipt) | [`certifiedDelivery`](#/definitions/certifiedDelivery) editor (can change recipients and document fields for later recipients/signers) | [`editor`](#/definitions/editor) in-person signer (\"hosts\" someone who signs in-person) | [`inPersonSigner`](#/definitions/inPersonSigner) intermediary (can add name and email information for some later recipients/signers.) | [`intermediary`](#/definitions/intermediary) signer (signs and/or updates document fields) | [`signer`](#/definitions/signer) Additional information about the different types of recipients is available from the [`EnvelopeRecipients` resource page](../../EnvelopeRecipients) and from the [Developer Center](https://www.docusign.com/developer-center/explore/features/recipients) ### Tabs Tabs (also referred to as `tags` and as `fields` in the web sending user interface), can be defined in the `envelopeDefinition`, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below). Defining tabs: the `inPersonSigner`, and `signer` recipient objects include a `tabs` field. It is an [`EnvelopeTabs` resource object](#/definitions/EnvelopeTabs). It includes arrays of the 24 different tab types available. See the [`EnvelopeTabs` resource](../../EnvelopeTabs) for more information. ## Using Templates Envelopes use specific people or groups as recipients. Templates can specify a role, eg `account_manager.` When a template is used in an envelope, the roles must be replaced with specific people or groups. When you create an envelope using a `templateId`, the different recipient type objects within the [`EnvelopeRecipients` object](#/definitions/EnvelopeRecipients) are used to assign recipients to the template's roles via the `roleName` property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template. ### Message Lock When a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The field `messageLock` is used to lock the email subject and message. If an email subject or message is entered before adding or applying a template with `messageLock` **true**, the email subject and message is overwritten with the locked email subject and message from the template. ## Envelope Status The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope's status changes. DocuSign limits polling to once every 15 minutes or less frequently. When a webhook is used, DocuSign calls your application, via the URL you provide, with a notification XML message. See the [Webhook recipe](https://www.docusign.com/developer-center/recipes/webhook-status) for examples and live demos of using webhooks. ## Webhook Options The two webhook options, *eventNotification* and *Connect* use the same notification mechanism and message formats. eventNotification is used to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client. ### eventNotification Webhooks The Envelopes::create method includes an optional [eventNotification object](#definition-eventNotification) that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access. ### Connect Webhooks Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or via other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc. Connect configurations may be created and managed using the [ConnectConfigurations resource](../../Connect/ConnectConfigurations). Configurations can also be created and managed from the Administration tool accessed by selecting \"Go to Admin\" from the menu next to your picture on the DocuSign web app. See the Integrations/Connect section of the Admin tool. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs. Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information. ## Composite Templates The Composite Templates feature, like [compositing in film production](https://en.wikipedia.org/wiki/Compositing), enables you to *overlay* document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more. Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents. * The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multi-part HTTP message. If used, the document content-disposition must include the `compositeTemplateId` to which the document should be added. If `compositeTemplateId` is not specified in the content-disposition, the document is applied based on the `documentId` only. If no document object is specified, the composite template inherits the first document. * Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value. * Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value. * Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the *first* document it finds from a server template or inline template, starting with the lowest sequence value. PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set `transformPdfFields` to \"true\" for the document. See the Transform PDF Fields section for more information about process. * PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat's XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value. ### Compositing the definitions Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied: * Templates are overlaid in the order of their Sequence value. * If Document is not passed into the Composite Template's `document` field, the *first* template's document (based on the template's Sequence value) is used. * Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing. For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) then where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template then where that role recipient is specified. * Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order. * If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput. * Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents. For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations. * roleName and tabLabel matching is case sensitive. * The defaultRecipient field enables you to specify which recipient the generated tabs from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the DefaultRecipient by specifying the mapping of the tab label that is created to one of the template recipients. * You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with \"\\*\" and then the system matches tabs that start with the label. * If no DefaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.) ### Including the Document Content for Composite Templates Document content can be supplied inline, using the `documentBase64` or can be included in a multi-part HTTP message. If a multi-part message is used and there are multiple Composite Templates, the document content-disposition can include the `compositeTemplateId` to which the document should be added. Using the `compositeTemplateId` sets which documents are associated with particular composite templates. An example of this usage is: ``` --5cd3320a-5aac-4453-b3a4-cbb52a4cba5d Content-Type: application/pdf Content-Disposition: file; filename=\"eula.pdf\"; documentId=1; compositeTemplateId=\"1\" Content-Transfer-Encoding: base64 ``` ### PDF Form Field Transformation Only the following PDF Form FieldTypes will be transformed to DocuSign tabs: CheckBox, DateTime, ListBox, Numeric, Password, Radio, Signature, and Text Field Properties that will be transformed: Read Only, Required, Max Length, Positions, and Initial Data. When transforming a *PDF Form Digital Signature Field,* the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be ------- | -------- DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab When transforming *PDF Form Text Fields,* the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be ------- | -------- DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials DocuSignEnvelopeID or eSignEnvelopeID | EnvelopeID DocuSignCompany or eSignCompany | Company DocuSignDateSigned or eSignDateSigned | Date Signed DocuSignTitle or eSignTitle | Title DocuSignFullName or eSignFullName | Full Name DocuSignSignerAttachmentOptional or eSignSignerAttachmentOptional | Optional Signer Attachment Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab. PDF Form Field Names that include \"DocuSignIgnoreTransform\" or \"eSignIgnoreTransform\" will not be transformed. PDF Form Date fields will be transformed to Date Signed fields if their name includes DocuSignDateSigned or eSignDateSigned. ## Template Email Subject Merge Fields This feature enables you to insert recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient's `roleName`, are added to the `emailSubject` when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. * To add a recipient's name in the subject line add the following text in the `emailSubject` when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `\"emailSubject\":\"[[Signer 1_UserName]], Please sign this NDA\",` * To add a recipient's email address in the subject line add the following text in the emailSubject when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `\"emailSubject\":\"[[Signer 1_Email]], Please sign this NDA\",` In both cases the <roleName> is the recipient's `roleName` in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject. ## Branding an envelope The following rules are used to determine the `brandId` used in an envelope: * If a `brandId` is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. * If more than one template is used in an envelope and more than one `brandId` is specified, the first `brandId` specified is used throughout the envelope. * In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the account's default signing brand is used. * For envelopes that do not meet any of the previous criteria, the account's default signing brand is used for the envelope. ## BCC Email address feature The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, don't use the BCC Email field. Use a Carbon Copy or Certified Delivery Recipient type. ## Merge Recipient Roles for Draft Envelopes When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could cause leave duplicate recipients in the envelope. To prevent this, the query parameter `merge_roles_on_draft` should be added when posting a draft envelope (status=created) with multiple templates. Doing this will merge template roles and remove empty recipients. ###### Note: DocuSign recommends that the `merge_roles_on_draft` query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeDefinition - (optional)
    
    options - for modifying the method behavior.
    
    Returns:
    
    EnvelopeSummary
    
    Throws:
    
    ApiException - if fails to make API call
  - createEnvelopeComments
```
public CommentHistoryResult createEnvelopeComments(String accountId,
                                                   String envelopeId,
                                                   CommentsPublish commentsPublish)
                                            throws ApiException
```
    Posts a list of comments for authorized user
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    commentsPublish - (optional)
    
    Returns:
    
    CommentHistoryResult
    
    Throws:
    
    ApiException - if fails to make API call
  - createEnvelopeRecipientPreview
```
public ViewUrl createEnvelopeRecipientPreview(String accountId,
                                              String envelopeId,
                                              RecipientPreviewRequest recipientPreviewRequest)
                                       throws ApiException
```
    Provides a URL to start a recipient view of the Envelope UI
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientPreviewRequest - (optional)
    
    Returns:
    
    ViewUrl
    
    Throws:
    
    ApiException - if fails to make API call
  - createEnvelopeRecipientSharedView
```
public ViewUrl createEnvelopeRecipientSharedView(String accountId,
                                                 String envelopeId,
                                                 RecipientViewRequest recipientViewRequest)
                                          throws ApiException
```
    Provides a URL to start a shared recipient view of the Envelope UI
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientViewRequest - (optional)
    
    Returns:
    
    ViewUrl
    
    Throws:
    
    ApiException - if fails to make API call
  - createEnvelopeTransferRules
```
public EnvelopeTransferRuleInformation createEnvelopeTransferRules(String accountId,
                                                                   EnvelopeTransferRuleRequest envelopeTransferRuleRequest)
                                                            throws ApiException
```
    Add envelope transfer rules to an account.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeTransferRuleRequest - (optional)
    
    Returns:
    
    EnvelopeTransferRuleInformation
    
    Throws:
    
    ApiException - if fails to make API call
  - createLock
```
public LockInformation createLock(String accountId,
                                  String envelopeId,
                                  LockRequest lockRequest)
                           throws ApiException
```
    Lock an envelope. Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    lockRequest - (optional)
    
    Returns:
    
    LockInformation
    
    Throws:
    
    ApiException - if fails to make API call
  - createRecipient
```
public Recipients createRecipient(String accountId,
                                  String envelopeId,
                                  Recipients recipients)
                           throws ApiException
```
    Adds one or more recipients to an envelope. Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipients - (optional)
    
    Returns:
    
    Recipients
    
    Throws:
    
    ApiException
  - createRecipient
```
public Recipients createRecipient(String accountId,
                                  String envelopeId,
                                  Recipients recipients,
                                  EnvelopesApi.CreateRecipientOptions options)
                           throws ApiException
```
    Adds one or more recipients to an envelope. Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipients - (optional)
    
    options - for modifying the method behavior.
    
    Returns:
    
    Recipients
    
    Throws:
    
    ApiException - if fails to make API call
  - createRecipientProofFileLink
```
public ProofServiceViewLink createRecipientProofFileLink(String accountId,
                                                         String envelopeId,
                                                         String recipientId)
                                                  throws ApiException
```
    Returns a link to access to the identity events stored in the proof service related to this recipient.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    Returns:
    
    ProofServiceViewLink
    
    Throws:
    
    ApiException - if fails to make API call
  - createRecipientProofFileResourceToken
```
public ProofServiceResourceToken createRecipientProofFileResourceToken(String tokenScopes,
                                                                       String accountId,
                                                                       String envelopeId,
                                                                       String recipientId)
                                                                throws ApiException
```
    Returns a resource token to get access to the identity events stored in the proof service related to this recipient.
    
    Parameters:
    
    tokenScopes - (required)
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    Returns:
    
    ProofServiceResourceToken
    
    Throws:
    
    ApiException - if fails to make API call
  - createRecipientView
```
public ViewUrl createRecipientView(String accountId,
                                   String envelopeId,
                                   RecipientViewRequest recipientViewRequest)
                            throws ApiException
```
    Returns a URL to the recipient view UI. Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientViewRequest - (optional)
    
    Returns:
    
    ViewUrl
    
    Throws:
    
    ApiException - if fails to make API call
  - createResponsiveHtmlPreview
```
public DocumentHtmlDefinitions createResponsiveHtmlPreview(String accountId,
                                                           String envelopeId,
                                                           DocumentHtmlDefinition documentHtmlDefinition)
                                                    throws ApiException
```
    Get Responsive HTML Preview for all documents in an envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentHtmlDefinition - (optional)
    
    Returns:
    
    DocumentHtmlDefinitions
    
    Throws:
    
    ApiException - if fails to make API call
  - createSenderView
```
public ViewUrl createSenderView(String accountId,
                                String envelopeId,
                                ReturnUrlRequest returnUrlRequest)
                         throws ApiException
```
    Returns a URL to the sender view UI. Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    returnUrlRequest - (optional)
    
    Returns:
    
    ViewUrl
    
    Throws:
    
    ApiException - if fails to make API call
  - createTabs
```
public Tabs createTabs(String accountId,
                       String envelopeId,
                       String recipientId,
                       Tabs tabs)
                throws ApiException
```
    Adds tabs for a recipient. Adds one or more tabs for a recipient.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    tabs - (optional)
    
    Returns:
    
    Tabs
    
    Throws:
    
    ApiException - if fails to make API call
  - deleteAttachments
```
public EnvelopeAttachmentsResult deleteAttachments(String accountId,
                                                   String envelopeId,
                                                   EnvelopeAttachmentsRequest envelopeAttachmentsRequest)
                                            throws ApiException
```
    Delete one or more attachments from a DRAFT envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    envelopeAttachmentsRequest - (optional)
    
    Returns:
    
    EnvelopeAttachmentsResult
    
    Throws:
    
    ApiException - if fails to make API call
  - deleteChunkedUpload
```
public ChunkedUploadResponse deleteChunkedUpload(String accountId,
                                                 String chunkedUploadId)
                                          throws ApiException
```
    Delete an existing ChunkedUpload.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    chunkedUploadId - (required)
    
    Returns:
    
    ChunkedUploadResponse
    
    Throws:
    
    ApiException - if fails to make API call
  - deleteCustomFields
```
public CustomFields deleteCustomFields(String accountId,
                                       String envelopeId,
                                       CustomFields customFields)
                                throws ApiException
```
    Deletes envelope custom fields for draft and in-process envelopes. Deletes envelope custom fields for draft and in-process envelopes.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    customFields - (optional)
    
    Returns:
    
    CustomFields
    
    Throws:
    
    ApiException - if fails to make API call
  - deleteDocumentFields
```
public DocumentFieldsInformation deleteDocumentFields(String accountId,
                                                      String envelopeId,
                                                      String documentId,
                                                      DocumentFieldsInformation documentFieldsInformation)
                                               throws ApiException
```
    Deletes custom document fields from an existing envelope document. Deletes custom document fields from an existing envelope document.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    documentFieldsInformation - (optional)
    
    Returns:
    
    DocumentFieldsInformation
    
    Throws:
    
    ApiException - if fails to make API call
  - deleteDocumentPage
```
public void deleteDocumentPage(String accountId,
                               String envelopeId,
                               String documentId,
                               String pageNumber)
                        throws ApiException
```
    Deletes a page from a document in an envelope. Deletes a page from a document in an envelope based on the page number.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    pageNumber - The page number being accessed. (required)
    
    Throws:
    
    ApiException - if fails to make API call
  - deleteDocumentTabs
```
public Tabs deleteDocumentTabs(String accountId,
                               String envelopeId,
                               String documentId,
                               Tabs tabs)
                        throws ApiException
```
    Deletes tabs from an envelope document
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    tabs - (optional)
    
    Returns:
    
    Tabs
    
    Throws:
    
    ApiException - if fails to make API call
  - deleteDocuments
```
public EnvelopeDocumentsResult deleteDocuments(String accountId,
                                               String envelopeId,
                                               EnvelopeDefinition envelopeDefinition)
                                        throws ApiException
```
    Deletes documents from a draft envelope. Deletes one or more documents from an existing draft envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    envelopeDefinition - (optional)
    
    Returns:
    
    EnvelopeDocumentsResult
    
    Throws:
    
    ApiException - if fails to make API call
  - deleteEmailSettings
```
public EmailSettings deleteEmailSettings(String accountId,
                                         String envelopeId)
                                  throws ApiException
```
    Deletes the email setting overrides for an envelope. Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    Returns:
    
    EmailSettings
    
    Throws:
    
    ApiException - if fails to make API call
  - deleteEnvelopeCorrectView
```
public void deleteEnvelopeCorrectView(String accountId,
                                      String envelopeId,
                                      CorrectViewRequest correctViewRequest)
                               throws ApiException
```
    Revokes the correction view URL to the Envelope UI
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    correctViewRequest - (optional)
    
    Throws:
    
    ApiException - if fails to make API call
  - deleteEnvelopeTransferRules
```
public void deleteEnvelopeTransferRules(String accountId,
                                        String envelopeTransferRuleId)
                                 throws ApiException
```
    Delete envelope transfer rules for an account.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeTransferRuleId - (required)
    
    Throws:
    
    ApiException - if fails to make API call
  - deleteEnvelopeWorkflowDefinition
```
public void deleteEnvelopeWorkflowDefinition(String accountId,
                                             String envelopeId)
                                      throws ApiException
```
    Delete the workflow definition for an envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    Throws:
    
    ApiException - if fails to make API call
  - deleteLock
```
public LockInformation deleteLock(String accountId,
                                  String envelopeId)
                           throws ApiException
```
    Deletes an envelope lock. Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    Returns:
    
    LockInformation
    
    Throws:
    
    ApiException - if fails to make API call
  - deleteRecipient
```
public Recipients deleteRecipient(String accountId,
                                  String envelopeId,
                                  String recipientId)
                           throws ApiException
```
    Deletes a recipient from an envelope. Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    Returns:
    
    Recipients
    
    Throws:
    
    ApiException - if fails to make API call
  - deleteRecipients
```
public Recipients deleteRecipients(String accountId,
                                   String envelopeId,
                                   Recipients recipients)
                            throws ApiException
```
    Deletes recipients from an envelope. Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipients - (optional)
    
    Returns:
    
    Recipients
    
    Throws:
    
    ApiException - if fails to make API call
  - deleteTabs
```
public Tabs deleteTabs(String accountId,
                       String envelopeId,
                       String recipientId,
                       Tabs tabs)
                throws ApiException
```
    Deletes the tabs associated with a recipient. Deletes one or more tabs associated with a recipient in a draft envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    tabs - (optional)
    
    Returns:
    
    Tabs
    
    Throws:
    
    ApiException - if fails to make API call
  - deleteTemplateWorkflowDefinition
```
public void deleteTemplateWorkflowDefinition(String accountId,
                                             String templateId)
                                      throws ApiException
```
    Delete the workflow definition for a template.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    templateId - The ID of the template being accessed. (required)
    
    Throws:
    
    ApiException - if fails to make API call
  - deleteTemplatesFromDocument
```
public void deleteTemplatesFromDocument(String accountId,
                                        String envelopeId,
                                        String documentId,
                                        String templateId)
                                 throws ApiException
```
    Deletes a template from a document in an existing envelope. Deletes the specified template from a document in an existing envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    templateId - The ID of the template being accessed. (required)
    
    Throws:
    
    ApiException - if fails to make API call
  - getAttachment
```
public void getAttachment(String accountId,
                          String envelopeId,
                          String attachmentId)
                   throws ApiException
```
    Retrieves an attachment from the envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    attachmentId - (required)
    
    Throws:
    
    ApiException - if fails to make API call
  - getAttachments
```
public EnvelopeAttachmentsResult getAttachments(String accountId,
                                                String envelopeId)
                                         throws ApiException
```
    Returns a list of attachments associated with the specified envelope
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    Returns:
    
    EnvelopeAttachmentsResult
    
    Throws:
    
    ApiException - if fails to make API call
  - getChunkedUpload
```
public ChunkedUploadResponse getChunkedUpload(String accountId,
                                              String chunkedUploadId)
                                       throws ApiException
```
    Retrieves the current metadata of a ChunkedUpload.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    chunkedUploadId - (required)
    
    Returns:
    
    ChunkedUploadResponse
    
    Throws:
    
    ApiException
  - getChunkedUpload
```
public ChunkedUploadResponse getChunkedUpload(String accountId,
                                              String chunkedUploadId,
                                              EnvelopesApi.GetChunkedUploadOptions options)
                                       throws ApiException
```
    Retrieves the current metadata of a ChunkedUpload.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    chunkedUploadId - (required)
    
    options - for modifying the method behavior.
    
    Returns:
    
    ChunkedUploadResponse
    
    Throws:
    
    ApiException - if fails to make API call
  - getCommentsTranscript
```
public byte[] getCommentsTranscript(String accountId,
                                    String envelopeId)
                             throws ApiException
```
    Gets comment transcript for envelope and user
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    Returns:
    
    byte[]
    
    Throws:
    
    ApiException
  - getCommentsTranscript
```
public byte[] getCommentsTranscript(String accountId,
                                    String envelopeId,
                                    EnvelopesApi.GetCommentsTranscriptOptions options)
                             throws ApiException
```
    Gets comment transcript for envelope and user
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    options - for modifying the method behavior.
    
    Returns:
    
    byte[]
    
    Throws:
    
    ApiException - if fails to make API call
  - getConsumerDisclosure
```
public ConsumerDisclosure getConsumerDisclosure(String accountId,
                                                String envelopeId,
                                                String recipientId,
                                                String langCode)
                                         throws ApiException
```
    Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    langCode - The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to Ã¯Â¿Â½browserÃ¯Â¿Â½ to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required)
    
    Returns:
    
    ConsumerDisclosure
    
    Throws:
    
    ApiException
  - getConsumerDisclosure
```
public ConsumerDisclosure getConsumerDisclosure(String accountId,
                                                String envelopeId,
                                                String recipientId,
                                                String langCode,
                                                EnvelopesApi.GetConsumerDisclosureOptions options)
                                         throws ApiException
```
    Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    langCode - The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to Ã¯Â¿Â½browserÃ¯Â¿Â½ to automatically detect the browser language being used by the viewer and display the disclosure in that language. (required)
    
    options - for modifying the method behavior.
    
    Returns:
    
    ConsumerDisclosure
    
    Throws:
    
    ApiException - if fails to make API call
  - getConsumerDisclosureDefault
```
public ConsumerDisclosure getConsumerDisclosureDefault(String accountId,
                                                       String envelopeId,
                                                       String recipientId)
                                                throws ApiException
```
    Gets the Electronic Record and Signature Disclosure associated with the account. Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    Returns:
    
    ConsumerDisclosure
    
    Throws:
    
    ApiException
  - getConsumerDisclosureDefault
```
public ConsumerDisclosure getConsumerDisclosureDefault(String accountId,
                                                       String envelopeId,
                                                       String recipientId,
                                                       EnvelopesApi.GetConsumerDisclosureDefaultOptions options)
                                                throws ApiException
```
    Gets the Electronic Record and Signature Disclosure associated with the account. Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    options - for modifying the method behavior.
    
    Returns:
    
    ConsumerDisclosure
    
    Throws:
    
    ApiException - if fails to make API call
  - getDocument
```
public byte[] getDocument(String accountId,
                          String envelopeId,
                          String documentId)
                   throws ApiException
```
    Gets a document from an envelope. Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    Returns:
    
    byte[]
    
    Throws:
    
    ApiException
  - getDocument
```
public byte[] getDocument(String accountId,
                          String envelopeId,
                          String documentId,
                          EnvelopesApi.GetDocumentOptions options)
                   throws ApiException
```
    Gets a document from an envelope. Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    options - for modifying the method behavior.
    
    Returns:
    
    byte[]
    
    Throws:
    
    ApiException - if fails to make API call
  - getDocumentPageImage
```
public byte[] getDocumentPageImage(String accountId,
                                   String envelopeId,
                                   String documentId,
                                   String pageNumber)
                            throws ApiException
```
    Gets a page image from an envelope for display. Retrieves a page image for display from the specified envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    pageNumber - The page number being accessed. (required)
    
    Returns:
    
    byte[]
    
    Throws:
    
    ApiException
  - getDocumentPageImage
```
public byte[] getDocumentPageImage(String accountId,
                                   String envelopeId,
                                   String documentId,
                                   String pageNumber,
                                   EnvelopesApi.GetDocumentPageImageOptions options)
                            throws ApiException
```
    Gets a page image from an envelope for display. Retrieves a page image for display from the specified envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    pageNumber - The page number being accessed. (required)
    
    options - for modifying the method behavior.
    
    Returns:
    
    byte[]
    
    Throws:
    
    ApiException - if fails to make API call
  - getDocumentTabs
```
public Tabs getDocumentTabs(String accountId,
                            String envelopeId,
                            String documentId)
                     throws ApiException
```
    Returns tabs on the document.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    Returns:
    
    Tabs
    
    Throws:
    
    ApiException
  - getDocumentTabs
```
public Tabs getDocumentTabs(String accountId,
                            String envelopeId,
                            String documentId,
                            EnvelopesApi.GetDocumentTabsOptions options)
                     throws ApiException
```
    Returns tabs on the document.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    options - for modifying the method behavior.
    
    Returns:
    
    Tabs
    
    Throws:
    
    ApiException - if fails to make API call
  - getEmailSettings
```
public EmailSettings getEmailSettings(String accountId,
                                      String envelopeId)
                               throws ApiException
```
    Gets the email setting overrides for an envelope. Retrieves the email override settings for the specified envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    Returns:
    
    EmailSettings
    
    Throws:
    
    ApiException - if fails to make API call
  - getEnvelope
```
public Envelope getEnvelope(String accountId,
                            String envelopeId)
                     throws ApiException
```
    Gets the status of a envelope. Retrieves the overall status for the specified envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    Returns:
    
    Envelope
    
    Throws:
    
    ApiException
  - getEnvelope
```
public Envelope getEnvelope(String accountId,
                            String envelopeId,
                            EnvelopesApi.GetEnvelopeOptions options)
                     throws ApiException
```
    Gets the status of a envelope. Retrieves the overall status for the specified envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    options - for modifying the method behavior.
    
    Returns:
    
    Envelope
    
    Throws:
    
    ApiException - if fails to make API call
  - getEnvelopeDocumentHtmlDefinitions
```
public DocumentHtmlDefinitionOriginals getEnvelopeDocumentHtmlDefinitions(String accountId,
                                                                          String envelopeId,
                                                                          String documentId)
                                                                   throws ApiException
```
    Get the Original HTML Definition used to generate the Responsive HTML for a given document.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    Returns:
    
    DocumentHtmlDefinitionOriginals
    
    Throws:
    
    ApiException - if fails to make API call
  - getEnvelopeHtmlDefinitions
```
public DocumentHtmlDefinitionOriginals getEnvelopeHtmlDefinitions(String accountId,
                                                                  String envelopeId)
                                                           throws ApiException
```
    Get the Original HTML Definition used to generate the Responsive HTML for the envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    Returns:
    
    DocumentHtmlDefinitionOriginals
    
    Throws:
    
    ApiException - if fails to make API call
  - getEnvelopeTransferRules
```
public EnvelopeTransferRuleInformation getEnvelopeTransferRules(String accountId)
                                                         throws ApiException
```
    Returns a list of envelope transfer rules in the specified account.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    Returns:
    
    EnvelopeTransferRuleInformation
    
    Throws:
    
    ApiException
  - getEnvelopeTransferRules
```
public EnvelopeTransferRuleInformation getEnvelopeTransferRules(String accountId,
                                                                EnvelopesApi.GetEnvelopeTransferRulesOptions options)
                                                         throws ApiException
```
    Returns a list of envelope transfer rules in the specified account.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    options - for modifying the method behavior.
    
    Returns:
    
    EnvelopeTransferRuleInformation
    
    Throws:
    
    ApiException - if fails to make API call
  - getEnvelopeWorkflowDefinition
```
public Workflow getEnvelopeWorkflowDefinition(String accountId,
                                              String envelopeId)
                                       throws ApiException
```
    Returns the workflow definition for an envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    Returns:
    
    Workflow
    
    Throws:
    
    ApiException - if fails to make API call
  - getFormData
```
public EnvelopeFormData getFormData(String accountId,
                                    String envelopeId)
                             throws ApiException
```
    Returns envelope form data for an existing envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    Returns:
    
    EnvelopeFormData
    
    Throws:
    
    ApiException - if fails to make API call
  - getLock
```
public LockInformation getLock(String accountId,
                               String envelopeId)
                        throws ApiException
```
    Gets envelope lock information. Retrieves general information about the envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    Returns:
    
    LockInformation
    
    Throws:
    
    ApiException - if fails to make API call
  - getNotificationSettings
```
public Notification getNotificationSettings(String accountId,
                                            String envelopeId)
                                     throws ApiException
```
    Gets envelope notification information. Retrieves the envelope notification, reminders and expirations, information for an existing envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    Returns:
    
    Notification
    
    Throws:
    
    ApiException - if fails to make API call
  - getPageTabs
```
public Tabs getPageTabs(String accountId,
                        String envelopeId,
                        String documentId,
                        String pageNumber)
                 throws ApiException
```
    Returns tabs on the specified page.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    pageNumber - The page number being accessed. (required)
    
    Returns:
    
    Tabs
    
    Throws:
    
    ApiException - if fails to make API call
  - getPages
```
public PageImages getPages(String accountId,
                           String envelopeId,
                           String documentId)
                    throws ApiException
```
    Returns document page image(s) based on input.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    Returns:
    
    PageImages
    
    Throws:
    
    ApiException
  - getPages
```
public PageImages getPages(String accountId,
                           String envelopeId,
                           String documentId,
                           EnvelopesApi.GetPagesOptions options)
                    throws ApiException
```
    Returns document page image(s) based on input.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    options - for modifying the method behavior.
    
    Returns:
    
    PageImages
    
    Throws:
    
    ApiException - if fails to make API call
  - getRecipientDocumentVisibility
```
public DocumentVisibilityList getRecipientDocumentVisibility(String accountId,
                                                             String envelopeId,
                                                             String recipientId)
                                                      throws ApiException
```
    Returns document visibility for the recipients
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    Returns:
    
    DocumentVisibilityList
    
    Throws:
    
    ApiException - if fails to make API call
  - getRecipientInitialsImage
```
public byte[] getRecipientInitialsImage(String accountId,
                                        String envelopeId,
                                        String recipientId)
                                 throws ApiException
```
    Gets the initials image for a user. Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \"Bob Smith\" to \"Bob%20Smith\" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    Returns:
    
    byte[]
    
    Throws:
    
    ApiException
  - getRecipientInitialsImage
```
public byte[] getRecipientInitialsImage(String accountId,
                                        String envelopeId,
                                        String recipientId,
                                        EnvelopesApi.GetRecipientInitialsImageOptions options)
                                 throws ApiException
```
    Gets the initials image for a user. Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \"Bob Smith\" to \"Bob%20Smith\" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    options - for modifying the method behavior.
    
    Returns:
    
    byte[]
    
    Throws:
    
    ApiException - if fails to make API call
  - getRecipientSignature
```
public UserSignature getRecipientSignature(String accountId,
                                           String envelopeId,
                                           String recipientId)
                                    throws ApiException
```
    Gets signature information for a signer or sign-in-person recipient. Retrieves signature information for a signer or sign-in-person recipient.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    Returns:
    
    UserSignature
    
    Throws:
    
    ApiException - if fails to make API call
  - getRecipientSignatureImage
```
public byte[] getRecipientSignatureImage(String accountId,
                                         String envelopeId,
                                         String recipientId)
                                  throws ApiException
```
    Retrieve signature image information for a signer/sign-in-person recipient. Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \"Bob Smith\" to \"Bob%20Smith\" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    Returns:
    
    byte[]
    
    Throws:
    
    ApiException
  - getRecipientSignatureImage
```
public byte[] getRecipientSignatureImage(String accountId,
                                         String envelopeId,
                                         String recipientId,
                                         EnvelopesApi.GetRecipientSignatureImageOptions options)
                                  throws ApiException
```
    Retrieve signature image information for a signer/sign-in-person recipient. Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: \"Bob Smith\" to \"Bob%20Smith\" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    options - for modifying the method behavior.
    
    Returns:
    
    byte[]
    
    Throws:
    
    ApiException - if fails to make API call
  - getTabsBlob
```
public void getTabsBlob(String accountId,
                        String envelopeId)
                 throws ApiException
```
    Get encrypted tabs for envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    Throws:
    
    ApiException - if fails to make API call
  - getTemplateRecipientDocumentVisibility
```
public DocumentVisibilityList getTemplateRecipientDocumentVisibility(String accountId,
                                                                     String templateId,
                                                                     String recipientId)
                                                              throws ApiException
```
    Returns document visibility for the recipients
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    templateId - The ID of the template being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    Returns:
    
    DocumentVisibilityList
    
    Throws:
    
    ApiException - if fails to make API call
  - getTemplateWorkflowDefinition
```
public Workflow getTemplateWorkflowDefinition(String accountId,
                                              String templateId)
                                       throws ApiException
```
    Returns the workflow definition for a template.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    templateId - The ID of the template being accessed. (required)
    
    Returns:
    
    Workflow
    
    Throws:
    
    ApiException - if fails to make API call
  - listAuditEvents
```
public EnvelopeAuditEventResponse listAuditEvents(String accountId,
                                                  String envelopeId)
                                           throws ApiException
```
    Gets the envelope audit events for an envelope. Gets the envelope audit events for the specified envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    Returns:
    
    EnvelopeAuditEventResponse
    
    Throws:
    
    ApiException - if fails to make API call
  - listCustomFields
```
public CustomFieldsEnvelope listCustomFields(String accountId,
                                             String envelopeId)
                                      throws ApiException
```
    Gets the custom field information for the specified envelope. Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    Returns:
    
    CustomFieldsEnvelope
    
    Throws:
    
    ApiException - if fails to make API call
  - listDocumentFields
```
public DocumentFieldsInformation listDocumentFields(String accountId,
                                                    String envelopeId,
                                                    String documentId)
                                             throws ApiException
```
    Gets the custom document fields from an existing envelope document. Retrieves the custom document field information from an existing envelope document.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    Returns:
    
    DocumentFieldsInformation
    
    Throws:
    
    ApiException - if fails to make API call
  - listDocuments
```
public EnvelopeDocumentsResult listDocuments(String accountId,
                                             String envelopeId)
                                      throws ApiException
```
    Gets a list of envelope documents. Retrieves a list of documents associated with the specified envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    Returns:
    
    EnvelopeDocumentsResult
    
    Throws:
    
    ApiException
  - listDocuments
```
public EnvelopeDocumentsResult listDocuments(String accountId,
                                             String envelopeId,
                                             EnvelopesApi.ListDocumentsOptions options)
                                      throws ApiException
```
    Gets a list of envelope documents. Retrieves a list of documents associated with the specified envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    options - for modifying the method behavior.
    
    Returns:
    
    EnvelopeDocumentsResult
    
    Throws:
    
    ApiException - if fails to make API call
  - listRecipients
```
public Recipients listRecipients(String accountId,
                                 String envelopeId)
                          throws ApiException
```
    Gets the status of recipients for an envelope. Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    Returns:
    
    Recipients
    
    Throws:
    
    ApiException
  - listRecipients
```
public Recipients listRecipients(String accountId,
                                 String envelopeId,
                                 EnvelopesApi.ListRecipientsOptions options)
                          throws ApiException
```
    Gets the status of recipients for an envelope. Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    options - for modifying the method behavior.
    
    Returns:
    
    Recipients
    
    Throws:
    
    ApiException - if fails to make API call
  - listStatus
```
public EnvelopesInformation listStatus(String accountId,
                                       EnvelopeIdsRequest envelopeIdsRequest)
                                throws ApiException
```
    Gets the envelope status for the specified envelopes. Retrieves the envelope status for the specified envelopes.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeIdsRequest - (optional)
    
    Returns:
    
    EnvelopesInformation
    
    Throws:
    
    ApiException
  - listStatus
```
public EnvelopesInformation listStatus(String accountId,
                                       EnvelopeIdsRequest envelopeIdsRequest,
                                       EnvelopesApi.ListStatusOptions options)
                                throws ApiException
```
    Gets the envelope status for the specified envelopes. Retrieves the envelope status for the specified envelopes.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeIdsRequest - (optional)
    
    options - for modifying the method behavior.
    
    Returns:
    
    EnvelopesInformation
    
    Throws:
    
    ApiException - if fails to make API call
  - listStatusChanges
```
public EnvelopesInformation listStatusChanges(String accountId)
                                       throws ApiException
```
    Gets status changes for one or more envelopes. Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the `envelopeIds` or `transactionIds` properties), you must add a set the `from_date` property in the request. Getting envelope status using `transactionIds` is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for \"any status change\" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (`from_to_status`) set to `Delivered` — the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of `Delivered` and a status of \"`Created`,`Sent`\", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of `Created` or `Sent`, and since an envelope that has been delivered can never have a status of `Created` or `Sent`, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    Returns:
    
    EnvelopesInformation
    
    Throws:
    
    ApiException
  - listStatusChanges
```
public EnvelopesInformation listStatusChanges(String accountId,
                                              EnvelopesApi.ListStatusChangesOptions options)
                                       throws ApiException
```
    Gets status changes for one or more envelopes. Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the `envelopeIds` or `transactionIds` properties), you must add a set the `from_date` property in the request. Getting envelope status using `transactionIds` is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for \"any status change\" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (`from_to_status`) set to `Delivered` — the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of `Delivered` and a status of \"`Created`,`Sent`\", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of `Created` or `Sent`, and since an envelope that has been delivered can never have a status of `Created` or `Sent`, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    options - for modifying the method behavior.
    
    Returns:
    
    EnvelopesInformation
    
    Throws:
    
    ApiException - if fails to make API call
  - listTabs
```
public Tabs listTabs(String accountId,
                     String envelopeId,
                     String recipientId)
              throws ApiException
```
    Gets the tabs information for a signer or sign-in-person recipient in an envelope. Retrieves information about the tabs associated with a recipient in a draft envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    Returns:
    
    Tabs
    
    Throws:
    
    ApiException
  - listTabs
```
public Tabs listTabs(String accountId,
                     String envelopeId,
                     String recipientId,
                     EnvelopesApi.ListTabsOptions options)
              throws ApiException
```
    Gets the tabs information for a signer or sign-in-person recipient in an envelope. Retrieves information about the tabs associated with a recipient in a draft envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    options - for modifying the method behavior.
    
    Returns:
    
    Tabs
    
    Throws:
    
    ApiException - if fails to make API call
  - listTemplates
```
public TemplateInformation listTemplates(String accountId,
                                         String envelopeId)
                                  throws ApiException
```
    Get List of Templates used in an Envelope This returns a list of the server-side templates, their name and ID, used in an envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    Returns:
    
    TemplateInformation
    
    Throws:
    
    ApiException
  - listTemplates
```
public TemplateInformation listTemplates(String accountId,
                                         String envelopeId,
                                         EnvelopesApi.ListTemplatesOptions options)
                                  throws ApiException
```
    Get List of Templates used in an Envelope This returns a list of the server-side templates, their name and ID, used in an envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    options - for modifying the method behavior.
    
    Returns:
    
    TemplateInformation
    
    Throws:
    
    ApiException - if fails to make API call
  - listTemplatesForDocument
```
public TemplateInformation listTemplatesForDocument(String accountId,
                                                    String envelopeId,
                                                    String documentId)
                                             throws ApiException
```
    Gets the templates associated with a document in an existing envelope. Retrieves the templates associated with a document in the specified envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    Returns:
    
    TemplateInformation
    
    Throws:
    
    ApiException
  - listTemplatesForDocument
```
public TemplateInformation listTemplatesForDocument(String accountId,
                                                    String envelopeId,
                                                    String documentId,
                                                    EnvelopesApi.ListTemplatesForDocumentOptions options)
                                             throws ApiException
```
    Gets the templates associated with a document in an existing envelope. Retrieves the templates associated with a document in the specified envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    options - for modifying the method behavior.
    
    Returns:
    
    TemplateInformation
    
    Throws:
    
    ApiException - if fails to make API call
  - putAttachment
```
public EnvelopeAttachmentsResult putAttachment(String accountId,
                                               String envelopeId,
                                               String attachmentId,
                                               Attachment attachment)
                                        throws ApiException
```
    Add an attachment to a DRAFT or IN-PROCESS envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    attachmentId - (required)
    
    attachment - (optional)
    
    Returns:
    
    EnvelopeAttachmentsResult
    
    Throws:
    
    ApiException - if fails to make API call
  - putAttachments
```
public EnvelopeAttachmentsResult putAttachments(String accountId,
                                                String envelopeId,
                                                EnvelopeAttachmentsRequest envelopeAttachmentsRequest)
                                         throws ApiException
```
    Add one or more attachments to a DRAFT or IN-PROCESS envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    envelopeAttachmentsRequest - (optional)
    
    Returns:
    
    EnvelopeAttachmentsResult
    
    Throws:
    
    ApiException - if fails to make API call
  - rotateDocumentPage
```
public void rotateDocumentPage(String accountId,
                               String envelopeId,
                               String documentId,
                               String pageNumber,
                               PageRequest pageRequest)
                        throws ApiException
```
    Rotates page image from an envelope for display. Rotates page image from an envelope for display. The page image can be rotated to the left or right.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    pageNumber - The page number being accessed. (required)
    
    pageRequest - (optional)
    
    Throws:
    
    ApiException - if fails to make API call
  - update
```
public EnvelopeUpdateSummary update(String accountId,
                                    String envelopeId,
                                    Envelope envelope)
                             throws ApiException
```
    Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add {\"status\":\"sent\"} to the request body to send the envelope. * Voids the specified in-process envelope. Add {\"status\":\"voided\", \"voidedReason\":\"The reason for voiding the envelope\"} to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add {\"emailSubject\":\"subject\", \"emailBlurb\":\"message\"} to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add {\"purgeState\":\"purge type\"} to the request body. *Additional information on purging documents* The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If `purgeState=\"documents_queued\"` is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If `purgeState= \"documents_and_metadata_queued\"` is used in the request, then the documents, attachments, and tabs are deleted.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    envelope - (optional)
    
    Returns:
    
    EnvelopeUpdateSummary
    
    Throws:
    
    ApiException
  - update
```
public EnvelopeUpdateSummary update(String accountId,
                                    String envelopeId,
                                    Envelope envelope,
                                    EnvelopesApi.UpdateOptions options)
                             throws ApiException
```
    Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add {\"status\":\"sent\"} to the request body to send the envelope. * Voids the specified in-process envelope. Add {\"status\":\"voided\", \"voidedReason\":\"The reason for voiding the envelope\"} to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add {\"emailSubject\":\"subject\", \"emailBlurb\":\"message\"} to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add {\"purgeState\":\"purge type\"} to the request body. *Additional information on purging documents* The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If `purgeState=\"documents_queued\"` is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If `purgeState= \"documents_and_metadata_queued\"` is used in the request, then the documents, attachments, and tabs are deleted.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    envelope - (optional)
    
    options - for modifying the method behavior.
    
    Returns:
    
    EnvelopeUpdateSummary
    
    Throws:
    
    ApiException - if fails to make API call
  - updateChunkedUpload
```
public ChunkedUploadResponse updateChunkedUpload(String accountId,
                                                 String chunkedUploadId)
                                          throws ApiException
```
    Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    chunkedUploadId - (required)
    
    Returns:
    
    ChunkedUploadResponse
    
    Throws:
    
    ApiException
  - updateChunkedUpload
```
public ChunkedUploadResponse updateChunkedUpload(String accountId,
                                                 String chunkedUploadId,
                                                 EnvelopesApi.UpdateChunkedUploadOptions options)
                                          throws ApiException
```
    Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    chunkedUploadId - (required)
    
    options - for modifying the method behavior.
    
    Returns:
    
    ChunkedUploadResponse
    
    Throws:
    
    ApiException - if fails to make API call
  - updateChunkedUploadPart
```
public ChunkedUploadResponse updateChunkedUploadPart(String accountId,
                                                     String chunkedUploadId,
                                                     String chunkedUploadPartSeq,
                                                     ChunkedUploadRequest chunkedUploadRequest)
                                              throws ApiException
```
    Add a chunk, a chunk 'part', to an existing ChunkedUpload.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    chunkedUploadId - (required)
    
    chunkedUploadPartSeq - (required)
    
    chunkedUploadRequest - (optional)
    
    Returns:
    
    ChunkedUploadResponse
    
    Throws:
    
    ApiException - if fails to make API call
  - updateCustomFields
```
public CustomFields updateCustomFields(String accountId,
                                       String envelopeId,
                                       CustomFields customFields)
                                throws ApiException
```
    Updates envelope custom fields in an envelope. Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    customFields - (optional)
    
    Returns:
    
    CustomFields
    
    Throws:
    
    ApiException - if fails to make API call
  - updateDocument
```
public EnvelopeDocument updateDocument(String accountId,
                                       String envelopeId,
                                       String documentId)
                                throws ApiException
```
    Adds a document to an existing draft envelope. Adds a document to an existing draft envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    Returns:
    
    EnvelopeDocument
    
    Throws:
    
    ApiException - if fails to make API call
  - updateDocumentFields
```
public DocumentFieldsInformation updateDocumentFields(String accountId,
                                                      String envelopeId,
                                                      String documentId,
                                                      DocumentFieldsInformation documentFieldsInformation)
                                               throws ApiException
```
    Updates existing custom document fields in an existing envelope document. Updates existing custom document fields in an existing envelope document.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    documentFieldsInformation - (optional)
    
    Returns:
    
    DocumentFieldsInformation
    
    Throws:
    
    ApiException - if fails to make API call
  - updateDocumentTabs
```
public Tabs updateDocumentTabs(String accountId,
                               String envelopeId,
                               String documentId,
                               Tabs tabs)
                        throws ApiException
```
    Updates the tabs for an envelope document
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentId - The ID of the document being accessed. (required)
    
    tabs - (optional)
    
    Returns:
    
    Tabs
    
    Throws:
    
    ApiException - if fails to make API call
  - updateDocuments
```
public EnvelopeDocumentsResult updateDocuments(String accountId,
                                               String envelopeId,
                                               EnvelopeDefinition envelopeDefinition)
                                        throws ApiException
```
    Adds one or more documents to an existing envelope document. Adds one or more documents to an existing envelope document.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    envelopeDefinition - (optional)
    
    Returns:
    
    EnvelopeDocumentsResult
    
    Throws:
    
    ApiException - if fails to make API call
  - updateEmailSettings
```
public EmailSettings updateEmailSettings(String accountId,
                                         String envelopeId,
                                         EmailSettings emailSettings)
                                  throws ApiException
```
    Updates the email setting overrides for an envelope. Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    emailSettings - (optional)
    
    Returns:
    
    EmailSettings
    
    Throws:
    
    ApiException - if fails to make API call
  - updateEnvelopeTransferRule
```
public EnvelopeTransferRule updateEnvelopeTransferRule(String accountId,
                                                       String envelopeTransferRuleId,
                                                       EnvelopeTransferRule envelopeTransferRule)
                                                throws ApiException
```
    Update an envelope transfer rule for an account.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeTransferRuleId - (required)
    
    envelopeTransferRule - (optional)
    
    Returns:
    
    EnvelopeTransferRule
    
    Throws:
    
    ApiException - if fails to make API call
  - updateEnvelopeTransferRules
```
public EnvelopeTransferRuleInformation updateEnvelopeTransferRules(String accountId,
                                                                   EnvelopeTransferRuleInformation envelopeTransferRuleInformation)
                                                            throws ApiException
```
    Update envelope transfer rules for an account.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeTransferRuleInformation - (optional)
    
    Returns:
    
    EnvelopeTransferRuleInformation
    
    Throws:
    
    ApiException - if fails to make API call
  - updateEnvelopeWorkflowDefinition
```
public Workflow updateEnvelopeWorkflowDefinition(String accountId,
                                                 String envelopeId,
                                                 Workflow workflow)
                                          throws ApiException
```
    Updates the envelope workflow definition for an envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    workflow - (optional)
    
    Returns:
    
    Workflow
    
    Throws:
    
    ApiException - if fails to make API call
  - updateLock
```
public LockInformation updateLock(String accountId,
                                  String envelopeId,
                                  LockRequest lockRequest)
                           throws ApiException
```
    Updates an envelope lock. Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    lockRequest - (optional)
    
    Returns:
    
    LockInformation
    
    Throws:
    
    ApiException - if fails to make API call
  - updateNotificationSettings
```
public Notification updateNotificationSettings(String accountId,
                                               String envelopeId,
                                               EnvelopeNotificationRequest envelopeNotificationRequest)
                                        throws ApiException
```
    Sets envelope notification (Reminders/Expirations) structure for an existing envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    envelopeNotificationRequest - (optional)
    
    Returns:
    
    Notification
    
    Throws:
    
    ApiException - if fails to make API call
  - updateRecipientDocumentVisibility
```
public DocumentVisibilityList updateRecipientDocumentVisibility(String accountId,
                                                                String envelopeId,
                                                                String recipientId,
                                                                DocumentVisibilityList documentVisibilityList)
                                                         throws ApiException
```
    Updates document visibility for the recipients
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    documentVisibilityList - (optional)
    
    Returns:
    
    DocumentVisibilityList
    
    Throws:
    
    ApiException - if fails to make API call
  - updateRecipientInitialsImage
```
public void updateRecipientInitialsImage(String accountId,
                                         String envelopeId,
                                         String recipientId)
                                  throws ApiException
```
    Sets the initials image for an accountless signer. Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false**.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    Throws:
    
    ApiException - if fails to make API call
  - updateRecipientSignatureImage
```
public void updateRecipientSignatureImage(String accountId,
                                          String envelopeId,
                                          String recipientId)
                                   throws ApiException
```
    Sets the signature image for an accountless signer. Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false**.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    Throws:
    
    ApiException - if fails to make API call
  - updateRecipients
```
public RecipientsUpdateSummary updateRecipients(String accountId,
                                                String envelopeId,
                                                Recipients recipients)
                                         throws ApiException
```
    Updates recipients in a draft envelope or corrects recipient information for an in process envelope. Updates recipients in a draft envelope or corrects recipient information for an in process envelope. For draft envelopes, you can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. Once an envelope has been sent, you can only edit: `email`, `userName`, `signerName`, `routingOrder`, `faxNumber`, and `deliveryMethod`. You can also select to resend an envelope by using the `resend_envelope` option. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the POST).
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipients - (optional)
    
    Returns:
    
    RecipientsUpdateSummary
    
    Throws:
    
    ApiException
  - updateRecipients
```
public RecipientsUpdateSummary updateRecipients(String accountId,
                                                String envelopeId,
                                                Recipients recipients,
                                                EnvelopesApi.UpdateRecipientsOptions options)
                                         throws ApiException
```
    Updates recipients in a draft envelope or corrects recipient information for an in process envelope. Updates recipients in a draft envelope or corrects recipient information for an in process envelope. For draft envelopes, you can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. Once an envelope has been sent, you can only edit: `email`, `userName`, `signerName`, `routingOrder`, `faxNumber`, and `deliveryMethod`. You can also select to resend an envelope by using the `resend_envelope` option. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the POST).
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipients - (optional)
    
    options - for modifying the method behavior.
    
    Returns:
    
    RecipientsUpdateSummary
    
    Throws:
    
    ApiException - if fails to make API call
  - updateRecipientsDocumentVisibility
```
public DocumentVisibilityList updateRecipientsDocumentVisibility(String accountId,
                                                                 String envelopeId,
                                                                 DocumentVisibilityList documentVisibilityList)
                                                          throws ApiException
```
    Updates document visibility for the recipients
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    documentVisibilityList - (optional)
    
    Returns:
    
    DocumentVisibilityList
    
    Throws:
    
    ApiException - if fails to make API call
  - updateTabs
```
public Tabs updateTabs(String accountId,
                       String envelopeId,
                       String recipientId,
                       Tabs tabs)
                throws ApiException
```
    Updates the tabs for a recipient. Updates one or more tabs for a recipient in a draft envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    tabs - (optional)
    
    Returns:
    
    Tabs
    
    Throws:
    
    ApiException - if fails to make API call
  - updateTabsBlob
```
public void updateTabsBlob(String accountId,
                           String envelopeId)
                    throws ApiException
```
    Update encrypted tabs for envelope.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    envelopeId - The envelopeId Guid of the envelope being accessed. (required)
    
    Throws:
    
    ApiException - if fails to make API call
  - updateTemplateRecipientDocumentVisibility
```
public TemplateDocumentVisibilityList updateTemplateRecipientDocumentVisibility(String accountId,
                                                                                String templateId,
                                                                                String recipientId,
                                                                                TemplateDocumentVisibilityList templateDocumentVisibilityList)
                                                                         throws ApiException
```
    Updates document visibility for the recipients
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    templateId - The ID of the template being accessed. (required)
    
    recipientId - The ID of the recipient being accessed. (required)
    
    templateDocumentVisibilityList - (optional)
    
    Returns:
    
    TemplateDocumentVisibilityList
    
    Throws:
    
    ApiException - if fails to make API call
  - updateTemplateRecipientsDocumentVisibility
```
public TemplateDocumentVisibilityList updateTemplateRecipientsDocumentVisibility(String accountId,
                                                                                 String templateId,
                                                                                 TemplateDocumentVisibilityList templateDocumentVisibilityList)
                                                                          throws ApiException
```
    Updates document visibility for the recipients
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    templateId - The ID of the template being accessed. (required)
    
    templateDocumentVisibilityList - (optional)
    
    Returns:
    
    TemplateDocumentVisibilityList
    
    Throws:
    
    ApiException - if fails to make API call
  - updateTemplateWorkflowDefinition
```
public Workflow updateTemplateWorkflowDefinition(String accountId,
                                                 String templateId,
                                                 Workflow workflow)
                                          throws ApiException
```
    Updates the workflow definition for a template.
    
    Parameters:
    
    accountId - The external account number (int) or account ID Guid. (required)
    
    templateId - The ID of the template being accessed. (required)
    
    workflow - (optional)
    
    Returns:
    
    Workflow
    
    Throws:
    
    ApiException - if fails to make API call

Class EnvelopesApi

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnvelopesApi

EnvelopesApi

Method Detail

getApiClient

setApiClient

applyTemplate

applyTemplate

applyTemplateToDocument

applyTemplateToDocument

createChunkedUpload

createConsoleView

createCorrectView

createCustomFields

createDocumentFields

createDocumentResponsiveHtmlPreview

createDocumentTabs

createEditView

createEmailSettings

createEnvelope

createEnvelope

createEnvelopeComments

createEnvelopeRecipientPreview

createEnvelopeRecipientSharedView

createEnvelopeTransferRules

createLock

createRecipient

createRecipient

createRecipientProofFileLink

createRecipientProofFileResourceToken

createRecipientView

createResponsiveHtmlPreview

createSenderView

createTabs

deleteAttachments

deleteChunkedUpload

deleteCustomFields

deleteDocumentFields

deleteDocumentPage

deleteDocumentTabs

deleteDocuments

deleteEmailSettings

deleteEnvelopeCorrectView

deleteEnvelopeTransferRules

deleteEnvelopeWorkflowDefinition

deleteLock

deleteRecipient

deleteRecipients

deleteTabs

deleteTemplateWorkflowDefinition

deleteTemplatesFromDocument

getAttachment

getAttachments

getChunkedUpload

getChunkedUpload

getCommentsTranscript

getCommentsTranscript

getConsumerDisclosure

getConsumerDisclosure

getConsumerDisclosureDefault

getConsumerDisclosureDefault

getDocument

getDocument

getDocumentPageImage

getDocumentPageImage

getDocumentTabs

getDocumentTabs

getEmailSettings

getEnvelope

getEnvelope

getEnvelopeDocumentHtmlDefinitions

getEnvelopeHtmlDefinitions

getEnvelopeTransferRules

getEnvelopeTransferRules

getEnvelopeWorkflowDefinition