Envelopetransferrules 3 endpoints

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

This method changes the status for one or more envelope transfer rules based on the envelopeTransferRuleIds in the request body. You use this method to change whether or not the rules are enabled.

Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.

operationId: EnvelopeTransferRules_PutEnvelopeTransferRules

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Request Body

application/json
schema envelopeTransferRuleInformation
Property Type Required
nextUri string optional
endPosition string optional
previousUri string optional
totalSetSize string optional
resultSetSize string optional
startPosition string optional
envelopeTransferRules array optional
└ toUser object optional
└ uri string optional
└ email string optional
└ title string optional
└ userId string optional
└ company string optional
└ isAdmin string optional
└ jobTitle string optional
└ lastName string optional
└ password string optional
└ userName string optional
└ userType string optional
└ firstName string optional
└ groupList array optional
└ users array optional
└ groupId string optional
└ dsGroupId string optional
└ groupName string optional
└ groupType string optional
└ usersCount string optional
└ errorDetails object optional
└ permissionProfileId string optional
└ lastLogin string optional
└ subscribe string optional
└ middleName string optional
└ suffixName string optional
└ userStatus string optional
└ countryCode string optional
└ homeAddress object optional
└ fax string optional
└ city string optional
└ phone string optional
└ country string optional
└ address1 string optional
└ address2 string optional
└ zipPlus4 string optional
└ postalCode string optional
└ stateOrProvince string optional
└ …24 more object optional
└ enabled string optional
└ fromUser object optional
└ uri string optional
└ email string optional
└ title string optional
└ userId string optional
└ company string optional
└ isAdmin string optional
└ jobTitle string optional
└ lastName string optional
└ password string optional
└ userName string optional
└ userType string optional
└ firstName string optional
└ groupList array optional
└ users array optional
└ groupId string optional
└ dsGroupId string optional
└ groupName string optional
└ groupType string optional
└ usersCount string optional
└ errorDetails object optional
└ permissionProfileId string optional
└ lastLogin string optional
└ subscribe string optional
└ middleName string optional
└ suffixName string optional
└ userStatus string optional
└ countryCode string optional
└ homeAddress object optional
└ fax string optional
└ city string optional
└ phone string optional
└ country string optional
└ address1 string optional
└ address2 string optional
└ zipPlus4 string optional
└ postalCode string optional
└ stateOrProvince string optional
└ …24 more object optional
└ toFolder object optional
└ uri string optional
└ name string optional
└ type string optional
└ owner object optional
└ uri string optional
└ email string optional
└ userId string optional
└ userName string optional
└ userType string optional
└ accountId string optional
└ ipAddress string optional
└ userStatus string optional
└ accountName string optional
└ loginStatus string optional
└ errorDetails object optional
└ membershipId string optional
└ sendActivationEmail string optional
└ activationAccessCode string optional
└ filter object optional
└ order string optional
└ status string optional
└ expires string optional
└ orderBy string optional
└ folderIds string optional
└ isTemplate string optional
└ searchText string optional
└ toDateTime string optional
└ fromDateTime string optional
└ searchTarget string optional
└ actionRequired string optional
└ folders array optional
└ folderId string optional
└ hasAccess string optional
└ itemCount string optional
└ folderItems array optional
└ status string optional
└ subject string optional
└ folderId string optional
└ folderUri string optional
└ ownerName string optional
└ envelopeId string optional
└ recipients object optional
└ senderName string optional
└ templateId string optional
└ envelopeUri string optional
└ senderEmail string optional
└ templateUri string optional
└ senderUserId string optional
└ sentDateTime string optional
└ is21CFRPart11 string optional
└ recipientsUri string optional
└ senderCompany string optional
└ expireDateTime string optional
└ createdDateTime string optional
└ completedDateTime string optional
└ …1 more object optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ hasSubFolders string optional
└ parentFolderId string optional
└ subFolderCount string optional
└ parentFolderUri string optional
└ eventType string optional
└ fromGroup object optional
└ users array optional
└ uri string optional
└ email string optional
└ userId string optional
└ userName string optional
└ userType string optional
└ accountId string optional
└ ipAddress string optional
└ userStatus string optional
└ accountName string optional
└ loginStatus string optional
└ errorDetails object optional
└ membershipId string optional
└ sendActivationEmail string optional
└ activationAccessCode string optional
└ groupId string optional
└ dsGroupId string optional
└ groupName string optional
└ groupType string optional
└ usersCount string optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ permissionProfileId string optional
└ modifiedDate string optional
└ modifiedUser object optional
└ uri string optional
└ email string optional
└ title string optional
└ userId string optional
└ company string optional
└ isAdmin string optional
└ jobTitle string optional
└ lastName string optional
└ password string optional
└ userName string optional
└ userType string optional
└ firstName string optional
└ groupList array optional
└ users array optional
└ groupId string optional
└ dsGroupId string optional
└ groupName string optional
└ groupType string optional
└ usersCount string optional
└ errorDetails object optional
└ permissionProfileId string optional
└ lastLogin string optional
└ subscribe string optional
└ middleName string optional
└ suffixName string optional
└ userStatus string optional
└ countryCode string optional
└ homeAddress object optional
└ fax string optional
└ city string optional
└ phone string optional
└ country string optional
└ address1 string optional
└ address2 string optional
└ zipPlus4 string optional
└ postalCode string optional
└ stateOrProvince string optional
└ …24 more object optional
└ envelopeTransferRuleId string optional
└ carbonCopyOriginalOwner string optional

Responses

200

Successful response.
400

Error encountered.
PUT /v2.1/accounts/{accountId}/envelopes/transfer_rules
DELETE /v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}

This method deletes an envelope transfer rule.

Note: Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.

operationId: EnvelopeTransferRules_DeleteEnvelopeTransferRules

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeTransferRuleId path required string

The ID of the envelope transfer rule. The system generates this ID when the rule is first created.

Responses

200

Successful response.
400

Error encountered.
DELETE /v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}
PUT /v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}

This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled.

You must include the envelopeTransferRuleId both as a query parameter, and in the request body.

Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.

operationId: EnvelopeTransferRules_PutEnvelopeTransferRule

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeTransferRuleId path required string

The ID of the envelope transfer rule. The system generates this ID when the rule is first created.

Request Body

application/json
schema envelopeTransferRule
Property Type Required
toUser object optional
└ uri string optional
└ email string optional
└ title string optional
└ userId string optional
└ company string optional
└ isAdmin string optional
└ jobTitle string optional
└ lastName string optional
└ password string optional
└ userName string optional
└ userType string optional
└ firstName string optional
└ groupList array optional
└ users array optional
└ uri string optional
└ email string optional
└ userId string optional
└ userName string optional
└ userType string optional
└ accountId string optional
└ ipAddress string optional
└ userStatus string optional
└ accountName string optional
└ loginStatus string optional
└ errorDetails object optional
└ membershipId string optional
└ sendActivationEmail string optional
└ activationAccessCode string optional
└ groupId string optional
└ dsGroupId string optional
└ groupName string optional
└ groupType string optional
└ usersCount string optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ permissionProfileId string optional
└ lastLogin string optional
└ subscribe string optional
└ middleName string optional
└ suffixName string optional
└ userStatus string optional
└ countryCode string optional
└ homeAddress object optional
└ fax string optional
└ city string optional
└ phone string optional
└ country string optional
└ address1 string optional
└ address2 string optional
└ zipPlus4 string optional
└ postalCode string optional
└ stateOrProvince string optional
└ …24 more object optional
enabled string optional
fromUser object optional
└ uri string optional
└ email string optional
└ title string optional
└ userId string optional
└ company string optional
└ isAdmin string optional
└ jobTitle string optional
└ lastName string optional
└ password string optional
└ userName string optional
└ userType string optional
└ firstName string optional
└ groupList array optional
└ users array optional
└ uri string optional
└ email string optional
└ userId string optional
└ userName string optional
└ userType string optional
└ accountId string optional
└ ipAddress string optional
└ userStatus string optional
└ accountName string optional
└ loginStatus string optional
└ errorDetails object optional
└ membershipId string optional
└ sendActivationEmail string optional
└ activationAccessCode string optional
└ groupId string optional
└ dsGroupId string optional
└ groupName string optional
└ groupType string optional
└ usersCount string optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ permissionProfileId string optional
└ lastLogin string optional
└ subscribe string optional
└ middleName string optional
└ suffixName string optional
└ userStatus string optional
└ countryCode string optional
└ homeAddress object optional
└ fax string optional
└ city string optional
└ phone string optional
└ country string optional
└ address1 string optional
└ address2 string optional
└ zipPlus4 string optional
└ postalCode string optional
└ stateOrProvince string optional
└ …24 more object optional
toFolder object optional
└ uri string optional
└ name string optional
└ type string optional
└ owner object optional
└ uri string optional
└ email string optional
└ userId string optional
└ userName string optional
└ userType string optional
└ accountId string optional
└ ipAddress string optional
└ userStatus string optional
└ accountName string optional
└ loginStatus string optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ membershipId string optional
└ sendActivationEmail string optional
└ activationAccessCode string optional
└ filter object optional
└ order string optional
└ status string optional
└ expires string optional
└ orderBy string optional
└ folderIds string optional
└ isTemplate string optional
└ searchText string optional
└ toDateTime string optional
└ fromDateTime string optional
└ searchTarget string optional
└ actionRequired string optional
└ folders array optional
└ folderId string optional
└ hasAccess string optional
└ itemCount string optional
└ folderItems array optional
└ status string optional
└ subject string optional
└ folderId string optional
└ folderUri string optional
└ ownerName string optional
└ envelopeId string optional
└ recipients object optional
└ seals array optional
└ agents array optional
└ editors array optional
└ signers array optional
└ notaries array optional
└ witnesses array optional
└ carbonCopies array optional
└ errorDetails object optional
└ participants array optional
└ intermediaries array optional
└ recipientCount string optional
└ inPersonSigners array optional
└ certifiedDeliveries array optional
└ currentRoutingOrder string optional
└ senderName string optional
└ templateId string optional
└ envelopeUri string optional
└ senderEmail string optional
└ templateUri string optional
└ senderUserId string optional
└ sentDateTime string optional
└ is21CFRPart11 string optional
└ recipientsUri string optional
└ senderCompany string optional
└ expireDateTime string optional
└ createdDateTime string optional
└ completedDateTime string optional
└ …1 more object optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ hasSubFolders string optional
└ parentFolderId string optional
└ subFolderCount string optional
└ parentFolderUri string optional
eventType string optional
fromGroup object optional
└ users array optional
└ uri string optional
└ email string optional
└ userId string optional
└ userName string optional
└ userType string optional
└ accountId string optional
└ ipAddress string optional
└ userStatus string optional
└ accountName string optional
└ loginStatus string optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ membershipId string optional
└ sendActivationEmail string optional
└ activationAccessCode string optional
└ groupId string optional
└ dsGroupId string optional
└ groupName string optional
└ groupType string optional
└ usersCount string optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ permissionProfileId string optional
modifiedDate string optional
modifiedUser object optional
└ uri string optional
└ email string optional
└ title string optional
└ userId string optional
└ company string optional
└ isAdmin string optional
└ jobTitle string optional
└ lastName string optional
└ password string optional
└ userName string optional
└ userType string optional
└ firstName string optional
└ groupList array optional
└ users array optional
└ uri string optional
└ email string optional
└ userId string optional
└ userName string optional
└ userType string optional
└ accountId string optional
└ ipAddress string optional
└ userStatus string optional
└ accountName string optional
└ loginStatus string optional
└ errorDetails object optional
└ membershipId string optional
└ sendActivationEmail string optional
└ activationAccessCode string optional
└ groupId string optional
└ dsGroupId string optional
└ groupName string optional
└ groupType string optional
└ usersCount string optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ permissionProfileId string optional
└ lastLogin string optional
└ subscribe string optional
└ middleName string optional
└ suffixName string optional
└ userStatus string optional
└ countryCode string optional
└ homeAddress object optional
└ fax string optional
└ city string optional
└ phone string optional
└ country string optional
└ address1 string optional
└ address2 string optional
└ zipPlus4 string optional
└ postalCode string optional
└ stateOrProvince string optional
└ …24 more object optional
envelopeTransferRuleId string optional
carbonCopyOriginalOwner string optional

Responses

200

Successful response.
400

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

Envelopeviews 7 endpoints

DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct

Revokes the correction view URL to the Envelope UI.

operationId: Views_DeleteEnvelopeCorrectView

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Request Body

#/components/requestBodies/correctViewRequest

Responses

200

Successful response.
400

Error encountered.
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct

Returns a URL that allows you to embed the envelope correction view of the DocuSign UI. To customize the appearance of the correction view, you can add special query parameters to the returned URL when you use it in your application.

You can revoke this URL by calling the deleteEnvelopeCorrectView endpoint.

Best practices

The returned URL expires after 10 minutes and can only be used once. Therefore, request the URL immediately before you redirect your user to it.

Due to screen space issues, do not use an <iframe> for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView.

Customizing the correction view

To customize the appearance of the correction view, you can add query parameters to the URL that is returned by this endpoint and used in your application. Do not add these query parameters to the URL of the endpoint itself.

For example, adding the following query parameters to the URL returned by this method causes the sending view to:

  • start in the tagging screen
  • hide the Edit Pages command
  • hide all of the options under the Actions dropdown except Save, Close, and Discard
https://demo.docusign.net/Member/StartInSession.aspx?StartConsole=1&t=dd3b7c4c-xxxx-xxxx-xxxx-50cd195a3401&DocuEnvelope=f37489d3-xxxx-xxxx-xxxx-4de057063d0e&\
        advcorrect=1&\
        showEditPages=false&\
        showHeaderActions=false

The default value reflects what happens
if you omit the customization query parameter.
You can use the interactive
Embedded Sending Demo tool
to see the effect of using different query parameters.

Query Parameter Default Value Alternate Value
sendButtonAction send

The Send button operates normally.		 redirect

The text of the button changes to Continue. Clicking it redirects to the returnUrl in the request object. If you intend to modify the envelope after redirection, see this note.
backButtonAction previousPage

The back arrow and back button operate normally.		 redirect

Clicking the back arrow and back button redirects to the returnUrl in the request object. If you intend to modify the envelope after redirection, see this note.
showBackButton true

Shows the back arrow and the back button.		 false

Hides the back arrow and the back button.
showEditRecipients true

Shows the Edit Recipients command in the action menu and in the Conditional Recipients settings.		 false

Hides the Edit Recipients command.
showEditDocuments true

Shows the Edit Documents command in the action menu and removes the Documents Gear icon.		 false

Hides the Edit Documents command.
showEditDocumentVisibility true

Shows the Documents Gear icon where the sender can edit document visibility.		 false

Hides the Documents Gear icon.
showEditPages true

Shows the Edit Pages command under the document thumbnail.		 false

Hides the Edit Pages command.
showMatchingTemplatesPrompt true

Shows the matching template prompt.		 false

Hides the matching template prompt.
showHeaderActions true

Shows all options under the Actions dropdown.		 false

Hides all options under the Actions dropdown except Save, Close, and Discard.
showDiscardAction true

Shows the Discard command under the Actions dropdown.		 false

Hides the Discard command.
advcorrect 1

Starts the signer in the tagging screen.		 0

Starts the signer in the prepare screen.
showTabPalette true

Shows the tab palette.		 false

Hides the tab palette.
tabPaletteType standard

Displays the standard tab palette.		 custom
merge
notary
seals
smartcontracts
annotations
smartSections

Displays the specified tab palette before the standard palette.

Modifying the envelope after redirection

If you use sendButtonAction=redirect or backButtonAction=redirect, and you intend to modify the envelope after redirection, you will need to lock the envelope and add an extra query parameter:

  1. Create a lock token for the envelope.
  2. Add the new lock token to the URL with the lockToken query parameter.

    ...&sendButtonAction=redirect&lockToken=MDgxZxabUVBiMWUzZWYz

    Note: The lockToken query parameter is case-sensitive.

After clicking Continue,
your user is redirected back to your integration.
You can then delete the lock token.

Information security notice

This method provides full access to the sending account. When you
use this view, the current user has full access to the account.
If the account has administrative privileges, then this method
also provides administrator access.

If your use case needs to enable a sender to update a draft
envelope before it is sent or make other changes, take one of the
following steps:

  • Configure each sender to have their own individual user account
    to use this API method.
  • Enhance your API integration so that this method is not needed.
    Your integration can create the tabs, recipients,
    and other envelope settings as needed.

Related topics

operationId: Views_PostEnvelopeCorrectView

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Request Body

#/components/requestBodies/correctViewRequest

Responses

201

Successful response.
400

Error encountered.
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/edit

Returns a URL that enables 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.

See Embedded signing and sending
to learn more about embedding.

Due to screen space issues,
do not use an <iframe> for embedded operations on mobile devices.
For iOS devices, DocuSign recommends using a WebView.

Information security notice

This method provides full access to the sending account. When you
use this view, the current user has full access to the account.
If the account has administrative privileges, then this method
also provides administrator access.

If your use case needs to enable a sender to update a draft envelope before it is sent or make other changes, take one of the following steps:

  • Configure each sender to have their own individual user account to use this API method.</li>
  • Enhance your API integration so that this method is not needed. Your integration can create the tabs, recipients, and other envelope settings as needed.</li>

Related topics

operationId: Views_PostEnvelopeEditView

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Request Body

#/components/requestBodies/returnUrlRequest

Responses

201

Successful response.
400

Error encountered.
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/edit
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient

Returns a URL that enables you to
embed the recipient view
of the
DocuSign UI in your applications. If the recipient is a signer,
then the view will provide the signing ceremony.

This method is only used with envelopes in the sent status.

Due to screen space issues, do not use an <iframe> for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView.

The returned URL

The URL returned in this method’s response is intended to be used
immediately to redirect the signer to the recipient view.
You can open the recipient view
in the current browser or in a new tab.
After the signer is redirected to the
recipient view, they must interact with the DocuSign system
periodically or their session will time out.

The returned URL can be used only once and expires after 5 minutes. Do not store or email the returned URL.

If you want to invite someone to an embedded signing session via
email, the email invitation’s URL must be to your application.
When invoked, your app should request a recipientView URL from
DocuSign and then redirect the signer to that URL.

How to specify the default language

You can append the locale
query parameter
to the URL returned by this method
to specify a language.

The language for the recipient view
follows this order or precedence:

  • The language specified by the sender for the recipient.
  • The locale parameter appended to the URL.
  • The account language if the signer has a DocuSign account.
  • The language used in a previous signing if the signer is return signer.
  • The browser language.

For example, to set the default language
to Canadian French, you would add this query parameter
to the returned URL:

...?locale=fr_CA

Authentication

Your application is responsible for authenticating the identity
of the recipient or signer when you use this method. Use the
following parameters to record how the recipient
was authenticated.

  • assertionId
  • authenticationInstant
  • authenticationMethod
  • clientUserId
  • securityDomain

At a minimum, authenticationMethod and clientUserId are
required. The information that you provide is included in the
envelope’s certificate of completion.

Sending to a remote signer

You can request a signing session for a remote recipient
who has a DocuSign account.

Authenticate the request using the recipient’s
credentials, and do not specify a clientUserId.
This differs from the typical behavior where the
request is authenticated using the sender’s credentials,
and the recipient has a clientUserId defined.

Redirecting back to returnUrl

After the signer completes or ends the signing ceremony, DocuSign
redirects the user’s browser back to your app via the
returnUrl that you supplied in the request.

The signer may be redirected through various DocuSign
subdomains, depending on the region of the account sending the
envelope. Please consult Allowlists for DocuSign eSignature service
in Security for DocuSign eSignature
when setting up your allowlists

The event status parameter

DocuSign appends an event query parameter to the returnUrl with the
outcome of the signing ceremony. Your app can use this event
parameter to determine the next step for the envelope.
Do not fetch the envelope status by using
Envelopes: get
or a similar method because doing so
will probably hit request and polling limits.

event query parameter Meaning
signing_complete The recipient has signed the document.
cancel The recipient decided to finish later.
decline The recipient declined to sign the document.
exception An exception has occurred on the server during the signing session.
fax_pending Recipient has a fax pending.
session_timeout The recipient did not sign the document in time. The timeout is set to 20 minutes.
ttl_expired The token was not used within the timeout period or the token has already been accessed.
viewing_complete The recipient did not need to sign but has completed the viewing ceremony.
Because a user can cancel redirection, close their browser after signing, or spoof the landing URL, you should not rely on the returnUrl alone as the single source of truth for envelope status for your integration.

Maintaining State

After the recipient completes the recipient view (or signing
ceremony), they are redirected to your application. Your
application can recover state information about the transaction
by storing information in a cookie, or by including query
parameters in the returnUrl field. For example.
https://myapp.example.com/docusign_return?myState=12345 When the
user is redirected to your app, the event query parameter will
be appended. In this example, prevent spoofing by not using a
guessable value as the state value.

Related topics

operationId: Views_PostEnvelopeRecipientView

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The ID of the draft envelope or template to preview.

Request Body

#/components/requestBodies/recipientViewRequest

Responses

201

Successful response.
400

Error encountered.
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender

Returns a URL that enables you to embed the sender view
of the DocuSign UI in your applications. To customize the appearance of the sender view, you can append special query parameters to the returned URL.

Best Practices

The returned URL can only be redirected to immediately after it
is generated. It can only be used once. Therefore, request the
URL immediately before you redirect your user to it.

Due to screen space issues,
do not use an <iframe> for embedded operations on mobile devices.
For iOS devices, DocuSign recommends using a WebView.

Customizing the sending view

You can add query parameters
to customize the appearance of the sending view.
For example, adding the following query parameters
to the URL returned by this method
causes the sending view to:

  • start in the tagging screen
  • hide the Edit Pages command
  • hide all of the options under the Actions dropdown except Save, Close, and Discard
https://demo.docusign.net/Member/StartInSession.aspx?StartConsole=1&t=dd3b7c4c-xxxx-xxxx-xxxx-50cd195a3401&DocuEnvelope=f37489d3-xxxx-xxxx-xxxx-4de057063d0e&\
        send=1&\
        showEditPages=false&\
        showHeaderActions=false

The default value reflects what happens
if you omit the customization query parameter.
You can use the interactive
Embedded Sending Demo tool
to see the effect of using different query parameters.

Query Parameter Default Value Alternate Value
sendButtonAction send

The Send button operates normally.		 redirect

The text of the button changes to Continue. Clicking it redirects to the returnUrl in the request object. If you intend to modify the envelope after redirection, see this note.
backButtonAction previousPage

The back arrow and back button operate normally.		 redirect

Clicking the back arrow and back button redirects to the returnUrl in the request object. If you intend to modify the envelope after redirection, see this note.
showBackButton true

Shows the back arrow and the back button.		 false

Hides the back arrow and the back button.
showEditRecipients true

Shows the Edit Recipients command in the action menu and in the Conditional Recipients settings.		 false

Hides the Edit Recipients command.
showEditDocuments true

Shows the Edit Documents command in the action menu and removes the Documents Gear icon.		 false

Hides the Edit Documents command.
showEditDocumentVisibility true

Shows the Documents Gear icon where the sender can edit document visibility.		 false

Hides the Documents Gear icon.
showEditPages true

Shows the Edit Pages command under the document thumbnail.		 false

Hides the Edit Pages command.
showMatchingTemplatesPrompt true

Shows the matching template prompt.		 false

Hides the matching template prompt.
showHeaderActions true

Shows all options under the Actions dropdown.		 false

Hides all options under the Actions dropdown except Save, Close, and Discard.
showDiscardAction true

Shows the Discard command under the Actions dropdown.		 false

Hides the Discard command.
send 1

Starts the signer in the tagging screen.		 0

Starts the signer in the prepare screen.
showTabPalette true

Shows the tab palette.		 false

Hides the tab palette.
tabPaletteType standard

Displays the standard tab palette.		 custom
merge
notary
seals
smartcontracts
annotations
smartSections

Displays the specified tab palette before the standard palette.

Modifying the envelope after redirection

If you use sendButtonAction=redirect
or
backButtonAction=redirect,
and
you intend to modify the envelope after redirection,
you will need to lock the envelope
and
add an extra query parameter:

  1. Create a lock token for the envelope.
  2. Add the new lock token to the URL with the lockToken query parameter.

    ...&sendButtonAction=redirect&lockToken=MDgxZxabUVBiMWUzZWYz

    Note: The lockToken query parameter is case-sensitive.

After clicking Continue,
your user is redirected back to your integration.
You can then delete the lock token.

Information security notice

This method provides full access to the sending account. When you
use this view, the current user has full access to the account.
If the account has administrative privileges, then this method
also provides administrator access.

If your use case needs to enable a sender to update a draft
envelope before it is sent or make other changes, take one of the
following steps:

  • Configure each sender to have their own individual user account
    to use this API method.
  • Enhance your API integration so that this method is not needed.
    Your integration can create the tabs, recipients,
    and other envelope settings as needed.

Related topics

operationId: Views_PostEnvelopeSenderView

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Request Body

#/components/requestBodies/returnUrlRequest

Responses

201

Successful response.
400

Error encountered.
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared

Returns a URL that enables you to embed the DocuSign UI recipient view of a shared envelope in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them.

Due to screen space issues,
do not use an <iframe> for embedded operations on mobile devices.
For iOS devices, DocuSign recommends using a WebView.

Related topics

operationId: Views_PostEnvelopeRecipientSharedView

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Request Body

#/components/requestBodies/recipientViewRequest

Responses

201

Successful response.
400

Error encountered.
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared
POST /v2.1/accounts/{accountId}/views/console

Returns a URL that enables you to embed the DocuSign UI in your applications. To view a specific envelope, set the envelopeId property in the request body.

Information security notice

This method provides full access to the sending account.

Related topics

operationId: Views_PostAccountConsoleView

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.

Request Body

application/json
schema consoleViewRequest
Property Type Required
returnUrl string optional
envelopeId string optional

Responses

201

Successful response.
400

Error encountered.
POST /v2.1/accounts/{accountId}/views/console

Envelopeworkflowdefinition 26 endpoints

DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow

Deletes the specified envelope’s workflow definition if it has one.

Note: If the envelope was scheduled to be sent, this endpoint will cancel the scheduled send and the envelope status will be reset to
created. To resend the envelope, call the update the status to sent with the Envelopes::Update method.

operationId: EnvelopeWorkflowDefinitionV2_DeleteEnvelopeWorkflowDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow

Returns the workflow definition for the envelope specified by envelopeId. If the envelope does not have a workflow object, this method returns a 404.

operationId: EnvelopeWorkflowDefinitionV2_GetEnvelopeWorkflowDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow

Updates the specified envelope’s workflow.

You can use this endpoint to add scheduled sending to a draft envelope. You can also update the scheduled sending for a sent envelope if the scheduled sending countdown is in progress. In that case, the envelope will be reset to a draft state.

You can also add delayed routing to a draft envelope or a sent envelope that has not started workflow processing.

operationId: EnvelopeWorkflowDefinitionV2_PutEnvelopeWorkflowDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Request Body

#/components/requestBodies/workflow

Responses

200

Successful response.
400

Error encountered.
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending

Deletes the scheduled sending rules for an envelope’s workflow. You cannot call this endpoint once the scheduled sending countdown has begun.

operationId: EnvelopeWorkflowScheduledSending_DeleteEnvelopeScheduledSendingDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending

Given a template and a workflow step, returns the scheduled sending rules for that workflow step.

Note: If the workflow step does not have a scheduled sending object, this method returns a 404.

operationId: EnvelopeWorkflowScheduledSending_GetEnvelopeScheduledSendingDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending

Updates the scheduled sending rules for an envelope’s workflow. The envelope must have an existing workflow object.

operationId: EnvelopeWorkflowScheduledSending_PutEnvelopeScheduledSendingDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Request Body

#/components/requestBodies/scheduledSending

Responses

200

Successful response.
400

Error encountered.
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps

Adds a new step to an envelope’s workflow.

operationId: EnvelopeWorkflowStep_PostEnvelopeWorkflowStepDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Request Body

#/components/requestBodies/workflowStep

Responses

201

Successful response.
400

Error encountered.
POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}

Deletes the workflow step specified by workflowStepId from an envelope specified by envelopeId.

operationId: EnvelopeWorkflowStep_DeleteEnvelopeWorkflowStepDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
workflowStepId path required string

The ID of the workflow step.

Responses

200

Successful response.
400

Error encountered.
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}

Returns a workflow step specified by workflowStepId for an envelope specified by envelopeId.

operationId: EnvelopeWorkflowStep_GetEnvelopeWorkflowStepDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
workflowStepId path required string

The ID of the workflow step.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}

Updates the workflow step specified by workflowStepId for an envelope.

You can use this endpoint to add or update delayed routing for a draft envelope. You can add or update delayed routing for a sent envelope as long as the previous workflow step has not been completed.

operationId: EnvelopeWorkflowStep_PutEnvelopeWorkflowStepDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
workflowStepId path required string

The ID of the workflow step.

Request Body

#/components/requestBodies/workflowStep

Responses

200

Successful response.
400

Error encountered.
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting

Delete the delayed routing object for an envelope’s workflow step. You cannot call this endpoint once the delay is in progress. As a workaround, you can update the delay or send time to one minute in the future using the updateEnvelopeDelayedRoutingDefinition endpoint.

Note: After deleting the delayed routing object, the workflow step still contains the pause_before action. Once the workflow step is reached, you will need to unpause the envelope. If you want to delete the step entirely, use deleteEnvelopeWorkflowStepDefinition instead.

operationId: EnvelopeWorkflowDelayedRouting_DeleteEnvelopeDelayedRoutingDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
workflowStepId path required string

The ID of the workflow step.

Responses

200

Successful response.
400

Error encountered.
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting

Given an envelope and a workflow step, returns the delayed routing rules for that workflow step.

Note: If the workflow step does not have a delayed routing object, this method returns a 404.

operationId: EnvelopeWorkflowDelayedRouting_GetEnvelopeDelayedRoutingDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
workflowStepId path required string

The ID of the workflow step.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting

Updates the delayed routing rules for an envelope’s workflow step definition.

You can use this endpoint to add delayed routing to a draft envelope or a sent envelope (as long as the previous workflow step has not yet been completed). You can also update the delayed routing rule for an envelope, as long as the delay is not yet complete. If you update the delayed routing rule while the delay is already in progress, the countdown will reset.

operationId: EnvelopeWorkflowDelayedRouting_PutEnvelopeDelayedRoutingDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
workflowStepId path required string

The ID of the workflow step.

Request Body

#/components/requestBodies/delayedRouting

Responses

200

Successful response.
400

Error encountered.
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting
DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow

Deletes the specified template’s workflow definition if it has one.

Note: If the specified template does not have a workflow definition, this endpoint returns a 200 response.

operationId: TemplateWorkflowDefinition_DeleteTemplateWorkflowDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.

Responses

200

Successful response.
400

Error encountered.
DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow
GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow

Returns the workflow definition for the template specified by templateId. If the template does not have a workflow object, this method returns a 404.

operationId: TemplateWorkflowDefinition_GetTemplateWorkflowDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow
PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow

Updates the specified template’s workflow definition.

operationId: TemplateWorkflowDefinition_PutTemplateWorkflowDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.

Request Body

#/components/requestBodies/workflow

Responses

200

Successful response.
400

Error encountered.
PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow
DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending

Deletes the scheduled sending rules for the template’s workflow.

operationId: TemplateWorkflowScheduledSending_DeleteTemplateScheduledSendingDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.

Responses

200

Successful response.
400

Error encountered.
DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending
GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending

Given a template specified by templateId, returns the scheduled sending rules for that template’s workflow object.

Note: If the template’s workflow does not have a scheduled sending object, this method returns a 404.

operationId: TemplateWorkflowScheduledSending_GetTemplateScheduledSendingDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending
PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending
operationId: TemplateWorkflowScheduledSending_PutTemplateScheduledSendingDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.

Request Body

#/components/requestBodies/scheduledSending

Responses

200

Successful response.
400

Error encountered.
PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending
POST /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps

Adds a new step to a template’s workflow.

operationId: TemplateWorkflowStep_PostTemplateWorkflowStepDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.

Request Body

#/components/requestBodies/workflowStep

Responses

201

Successful response.
400

Error encountered.
POST /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps
DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}

Deletes a workflow step from an template’s workflow definition.

operationId: TemplateWorkflowStep_DeleteTemplateWorkflowStepDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.
workflowStepId path required string

The ID of the workflow step.

Responses

200

Successful response.
400

Error encountered.
DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}
GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}

Returns a workflow step specified by workflowStepId for a template specified by templateId.

operationId: TemplateWorkflowStep_GetTemplateWorkflowStepDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.
workflowStepId path required string

The ID of the workflow step.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}
PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}

Updates a specified workflow step for a template.

operationId: TemplateWorkflowStep_PutTemplateWorkflowStepDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.
workflowStepId path required string

The ID of the workflow step.

Request Body

#/components/requestBodies/workflowStep

Responses

200

Successful response.
400

Error encountered.
PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}
DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting

Deletes the delayed routing rules for the specified template workflow step.

operationId: TemplateWorkflowDelayedRouting_DeleteTemplateDelayedRoutingDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.
workflowStepId path required string

The ID of the workflow step.

Responses

200

Successful response.
400

Error encountered.
DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting
GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting

Given a template and a workflow step, returns the delayed routing rules for that workflow step.

Note: If the workflow step does not have a delayed routing object, this method returns a 404.

operationId: TemplateWorkflowDelayedRouting_GetTemplateDelayedRoutingDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.
workflowStepId path required string

The ID of the workflow step.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting
PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting

Updates the scheduled sending rules for a template’s workflow.

operationId: TemplateWorkflowDelayedRouting_PutTemplateDelayedRoutingDefinition

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
templateId path required string

The ID of the template.
workflowStepId path required string

The ID of the workflow step.

Request Body

#/components/requestBodies/delayedRouting

Responses

200

Successful response.
400

Error encountered.
PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting

Envelopes 14 endpoints

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

This method lets you
search for envelopes
in your accounts.
A large set of filters let you narrow the scope of your search
by date,
by envelope ID,
or by status codes.
Your request must include one or more of the following parameters:

  • from_date
  • envelope_ids
  • transaction_ids
This method excludes envelopes older than six months.

To avoid unnecessary database queries, the DocuSign
signature platform first checks requests to ensure that the
filter set supplied does not result in a zero-size response
before querying the database.

For example, for a request with a from_to_status of
delivered and a current status of created,sent,
DocuSign will always return an empty list.
This is because the request translates to: find the
envelopes that were delivered between the from_date and
to_date dates that have a current status of created or
sent. 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 query the database
and returns an empty list immediately.

Getting envelope status using transaction_ids is useful
for offline signing situations where it can be used
determine if an envelope was created or not. It can be used
for the cases where a network connection was lost, before
the envelope status could be returned.

The following table shows the valid current envelope
statuses (status parameter) for the different status
qualifiers (from_to_status parameter) 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.

Client applications should check that the statuses (status
parameter) they are requesting make sense for a given
from_to_status parameter value.

Status Qualifier
(from_to_status)		 Effective Status Qualifier Valid Current Statuses
any (changed) StatusChanged any, created, sent, delivered, signed, completed, declined, voided, deleted
created Created any, created, sent, delivered, signed, completed, declined, voided, deleted
sent Sent any, sent, delivered, signed, completed, declined, voided, deleted
delivered StatusChanged any, delivered, signed, completed, declined, voided, deleted
signed StatusChanged any, signed, completed, declined, voided, deleted
completed Completed any, completed, declined, voided, deleted
declined StatusChanged any, declined, voided, deleted
timedout
always return zero results		 StatusChanged any, voided, deleted
voided Voided any, voided, deleted
deleted StatusChanged any, deleted

Extraneous results

In some cases, a request for a specific envelope status will
include envelopes with additional statuses. For example, in
a request with a from_date of 2017-01-01, a to_date of
2017-01-07 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. As a workaround, check the envelope
status values in the result set as needed.

Related topics

operationId: Envelopes_GetEnvelopes

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
ac_status query optional string

Specifies the Authoritative Copy Status for the envelopes. Valid values: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed.
block query optional string

Reserved for DocuSign.
cdse_mode query optional string

Reserved for DocuSign.
continuation_token query optional string

Reserved for DocuSign.
count query optional string

The maximum number of results to return.

Use start_position to specify the number of results to skip.
custom_field query optional string

Optional. Specifies an envelope custom field name and value searched for in the envelopes. Format: custom_envelope_field_name=desired_value

Example: If you have an envelope custom field named “Region” and you want to search for all envelopes where the value is “West” you would use set this parameter to Region=West.
email query optional string

Limit results to envelopes
sent by the account user
with this email address.

user_name must be given as well,
and both email and user_name
must refer to an existing account user.
envelope_ids query optional string

Comma separated list of envelopeId values.
exclude query optional string

Excludes information from the response. Enter as a comma-separated list (e.g., folders,powerforms). Valid values are:

  • recipients
  • powerforms
  • folders
folder_ids query optional string

Returns the envelopes from specific folders. Enter as a comma-separated list of either valid folder Guids or the following values:

  • awaiting_my_signature
  • completed
  • draft
  • drafts
  • expiring_soon
  • inbox
  • out_for_signature
  • recyclebin
  • sentitems
  • waiting_for_others
folder_types query optional string

A comma-separated list of folder types you want to retrieve envelopes from. Valid values are:

  • normal
  • inbox
  • sentitems
  • draft
  • templates
from_date query optional string

Specifies the date and time
to start looking for status changes.
This parameter is required
unless envelopeIds or transactionIds
are set.

Although you can use any date format
supported by the .NET system library’s
DateTime.Parse() function,
DocuSign recommends
using ISO 8601 format dates
with an explicit time zone offset
If you do not provide
a time zone offset,
the method uses the server’s time zone.

For example, the following dates and times refer to the same instant:

  • 2017-05-02T01:44Z
  • 2017-05-01T21:44-04:00
  • 2017-05-01T18:44-07:00
from_to_status query optional string

This is the status type checked for in the from_date/to_date period. If changed is specified, then envelopes that changed status during the period are found. If for example, created is specified, then envelopes created during the period are found. Default is changed.

Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.
include query optional string

Specifies additional information to return about the envelopes.
Use a comma-separated list, such as folders, recipients to specify information.
Valid values are:

  • custom_fields: The custom fields associated with the envelope.
  • documents: The documents associated with the envelope.
  • attachments: The attachments associated with the envelope.
  • extensions: Information about the email settings associated with the envelope.
  • folders: The folders where the envelope exists.
  • recipients: The recipients associated with the envelope.
  • payment_tabs: The payment tabs associated with the envelope.
include_purge_information query optional string

When true, information about envelopes that have been deleted is included in the response.
intersecting_folder_ids query optional string

A comma-separated list of folders that you want want to get envelopes from. Valid values are:

  • normal
  • inbox
  • sentitems
  • draft
  • templates
last_queried_date query optional string

Returns envelopes that were modified prior to the specified date and time.

Example: 2020-05-09T21:56:12.2500000Z
order query optional string

Returns envelopes in either ascending (asc) or descending (desc) order.
order_by query optional string

Sorts results according to a specific property. Valid values are:

  • last_modified
  • action_required
  • created
  • completed
  • envelope_name
  • expire
  • sent
  • signer_list
  • status
  • subject
  • user_name
  • status_changed
  • last_modified
powerformids query optional string

A comma-separated list of PowerFormId values.
query_budget query optional string

The time in seconds that the query should run before returning data.
requester_date_format query optional string —
search_mode query optional string —
search_text query optional string

Free text search criteria that you can use to filter the list of envelopes that is returned.
start_position query optional string

The zero-based index of the
result from which to start returning results.

Use with count to limit the number
of results.

The default value is 0.
status query optional string

A comma-separated list of current envelope statuses to included in the response. Possible values are:

  • completed
  • created
  • declined
  • deleted
  • delivered
  • processing
  • sent
  • signed
  • timedout
  • voided

The any value is equivalent to any status.
to_date query optional string

Specifies the date and time
to stop looking for status changes.
The default is the current date and time.

Although you can use any date format
supported by the .NET system library’s
DateTime.Parse() function,
DocuSign recommends
using ISO 8601 format dates
with an explicit time zone offset
If you do not provide
a time zone offset,
the method uses the server’s time zone.

For example, the following dates and times refer to the same instant:

  • 2017-05-02T01:44Z
  • 2017-05-01T21:44-04:00
  • 2017-05-01T18:44-07:00
transaction_ids query optional string

If included in the query string, this is a comma separated list of envelope transactionIds.

If included in the request_body, this is a list of envelope transactionIds.

Note: transactionIds are only valid in the DocuSign system for seven days.
user_filter query optional string

Returns envelopes where the current user is the recipient, the sender, or the recipient only. (For example, user_filter=sender.) Valid values are:

  • sender
  • recipient
  • recipient_only
user_id query optional string

The ID of the user who created the envelopes to be retrieved. Note that an account can have multiple users, and any user with account access can retrieve envelopes by user_id from the account.
user_name query optional string

Limit results to envelopes
sent by the account user
with this user name.

email must be given as well,
and both email and user_name
must refer to an existing account user.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes
POST /v2.1/accounts/{accountId}/envelopes

Creates and sends an envelope or creates a draft envelope.
Envelopes are fundamental resources in the DocuSign platform.

With this method you can:

When you use this method
to create and send an envelope
in a single request,
the following parameters in the request body (an envelopeDefinition object) are required:

Parameter Description
status Set to sent to send the envelope to recipients.
Set to created (or don’t set at all) to save the envelope as a draft.
emailSubject The subject of the email used to send the envelope.
documents The documents to be signed.
recipients The email addresses of the envelope recipients.

When you create an envelope by using a
composite template,
you should specify the envelope custom fields in the inline template.
Any custom fields that you specify at the root level are ignored.

If the envelope has a workflow definition
and the workflowStatus is paused,
the envelope will not be sent immediately,
even if the envelope’s status is sent.

Related topics

Envelope and template
objects along with documents,
recipients, and tabs
are the five object models at the core of the eSignature API.
The eSignature concepts guide
describes how the five object models work together.

The following how-to articles contain
practical examples that show you how to
to
configure this method’s
envelopeDefinition request body
to perform common tasks.

Requesting a signature

Working with envelopes and templates

Working with advanced recipient routing

Working with documents

Working with tabs

Working with brands

Working with permissions

Implementing multi-factor recipient (signer) authentication

operationId: Envelopes_PostEnvelopes

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
cdse_mode query optional string

Reserved for DocuSign.
change_routing_order query optional string

When true, users can define the routing order of recipients while sending documents for signature.
completed_documents_only query optional string

Reserved for DocuSign.
merge_roles_on_draft query optional string

When true, template roles will be merged, and empty recipients will be removed. This parameter applies when you create a draft envelope with multiple templates. (To create a draft envelope, the status field is set to created.)

Note: DocuSign recommends that this parameter should be set to true whenever you create a draft envelope with multiple templates.

Request Body

#/components/requestBodies/envelopeDefinition

Responses

201

Successful response.
400

Error encountered.
POST /v2.1/accounts/{accountId}/envelopes
PUT /v2.1/accounts/{accountId}/envelopes/status

Retrieves envelope statuses for a set of envelopes.

To search for envelopes using a broad range of filters, use Envelopes: listStatusChanges instead of this method.

You must specify exactly one of the following query parameters:

Parameter Description
from_date a valid UTC DateTime: 2016-01-01
envelope_ids A comma-separated list of envelope IDs
or the special value request_body
transaction_ids A comma-separated list of transaction IDs
or the special value request_body

When you use the special value request_body, the request body looks like this:

{
  "envelopeIds": [
    "44c5ad6c-xxxx-xxxx-xxxx-ebda5e2dfe15",
    "8e26040d-xxxx-xxxx-xxxx-1e29b924d237",
    "c8b40a2d-xxxx-xxxx-xxxx-4fe56fe10f95"
  ]
}
Omitting the request body altogether causes the endpoint to return an error. The request body must be at least {}.

Related topics

operationId: Envelopes_PutStatus

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
ac_status query optional string

Specifies the Authoritative Copy Status for the envelopes. Valid values:

  • Unknown
  • Original
  • Transferred
  • AuthoritativeCopy
  • AuthoritativeCopyExportPending
  • AuthoritativeCopyExported
  • DepositPending
  • Deposited
  • DepositedEO
  • DepositFailed
block query optional string

When true, removes any results that match one of the provided transaction_ids.
count query optional string

The maximum number of results to return.

Use start_position to specify the number of results to skip.
email query optional string

The email address of the sender.
envelope_ids query optional string

The envelope IDs to include in the results.

The value of this property can be:

  • A comma-separated list of envelope IDs
  • The special value request_body. In this case, the method uses the envelope IDs in the request body.
from_date query optional string

The date/time setting that specifies when the request begins checking for status changes for envelopes in the account. This is required unless parameters envelope_ids and/or transaction_Ids are provided.

Note: This parameter must be set to a valid DateTime, or envelope_ids and/or transaction_ids must be specified.
from_to_status query optional string

The envelope status that you are checking for. Possible values are:

  • Changed (default)
  • Completed
  • Created
  • Declined
  • Deleted
  • Delivered
  • Processing
  • Sent
  • Signed
  • TimedOut
  • Voided

For example, if you specify Changed, this method
returns a list of envelopes that changed status
during the from_date to to_date time period.
start_position query optional string

The zero-based index of the
result from which to start returning results.

Use with count to limit the number
of results.

The default value is 0.
status query optional string

A comma-separated list of envelope status to search for. Possible values are:

  • completed
  • created
  • declined
  • deleted
  • delivered
  • processing
  • sent
  • signed
  • template
  • voided
to_date query optional string

Optional date/time setting
that specifies the last date/time
or envelope status changes in the result set.

The default value is the time that you call the method.
transaction_ids query optional string

The transaction IDs to include in the results. Note that transaction IDs are valid for seven days.

The value of this property can be:

  • A list of comma-separated transaction IDs
  • The special value request_body. In this case, this method uses the transaction IDs in the request body.
user_name query optional string

Limits results to envelopes
sent by the account user
with this user name.

email must be given as well,
and both email and user_name
must refer to an existing account user.

Request Body

application/json
schema envelopeIdsRequest
Property Type Required
envelopeIds array optional
transactionIds array optional

Responses

200

Successful response.
400

Error encountered.
PUT /v2.1/accounts/{accountId}/envelopes/status
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}

Retrieves the overall status for the specified envelope.
To get the status of a list of envelopes, use
Envelope: listStatusChanges.

Related topics

operationId: Envelopes_GetEnvelope

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
advanced_update query optional string

When true, envelope information can be added or modified.
include query optional string

Specifies additional information about the envelope to return. Enter a comma-separated list, such as tabs,recipients. Valid values are:

  • custom_fields: The custom fields associated with the envelope.
  • documents: The documents associated with the envelope.
  • attachments: The attachments associated with the envelope.
  • extensions: The email settings associated with the envelope.
  • folders: The folder where the envelope exists.
  • recipients: The recipients associated with the envelope.
  • powerform: The PowerForms associated with the envelope.
  • tabs: The tabs associated with the envelope.
  • payment_tabs: The payment tabs associated with the envelope.
  • workflow: The workflow definition associated with the envelope.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}

This method enables you to make changes to an envelope.
You can use it to:

Although the request body for this method
is a complete envelope definition,
you only need to provide
the properties that
you’re updating.

Sending a draft envelope

To send a draft envelope, include the following code in the request body:

{
  "status": "sent"
}

You can attach a workflow before sending the envelope:

{
  "status": "sent",
  "workflow": {
    "workflowSteps": [
      {
        "action": "pause_before",
        "description": "pause_before routing order 2",
        "itemId": 2,
        "triggerOnItem": "routing_order"
      }
    ]
  }
}

Working with workflows

To unpause a workflow, the request body should include this:

{
  "workflow": {
    "workflowStatus": "in_progress"
  }
}

Voiding an in-process envelope

To void an in-process envelope, include the following code in the request body:

{
  "status": "voided",
  "voidedReason": "The reason for voiding the envelope"
}

Modifying envelope email information

To change the email subject and message of a draft envelope,
include the following code in the request body:

{
  "emailSubject": "new email subject",
  "emailBlurb": "new email message"
}

Purging documents from DocuSign

To place only the documents
in the purge queue,
leaving any
corresponding attachments
and tabs in the DocuSign platform,
set the purgeState property
to documents_queued.

{
  "envelopeId": "222e6847-xxxx-xxxx-xxxx-72a3c9c16fca",
  "purgeState": "documents_queued"
}

To place documents,
attachments,
and tabs
in the purge queue,
set the purgeState property
to documents_and_metadata_queued.

{
  "envelopeId": "222e6847-xxxx-xxxx-xxxx-72a3c9c16fca",
  "purgeState": "documents_and_metadata_queued"
}

To place documents,
attachments,
and tabs
in the purge queue
and to redact personal information,
set the purgeState property
to documents_and_metadata_and_redact_queued.

{
  "envelopeId": "222e6847-xxxx-xxxx-xxxx-72a3c9c16fca",
  "purgeState": "documents_and_metadata_and_redact_queued"
}

You can purge documents
only from completed envelopes
that are not marked as the authoritative copy.
The user requesting the purge
must have permission to purge documents
and
must be the sender or be acting on behalf of the sender.

When the purge request is initiated
the items to be purged
are placed in the purge queue
for deletion in 14 days.
The sender
and
all recipients with DocuSign accounts
associated with the envelope
get an email notification
the documents will be deleted in 14 days.
The notification contains a link
to the documents.
A second email notification
is sent 7 days later.
At the end of the 14-day period
the documents are deleted from the system.
Recipients without DocuSign accounts
do not receive email notifications.

If your account has a Document Retention policy,
envelope documents
are automatically placed
in the purge queue,
and notification emails are sent
at the end of the retention period.
Setting a Document Retention policy is the same as setting a
schedule for purging documents.

Removing documents from the purge queue

To remove documents from the purge queue, include the following code in the request body:

{
  "envelopeId": "222e6847-xxxx-xxxx-xxxx-72a3c9c16fca",
  "purgeState": "documents_dequeued"
}

Related topics

operationId: Envelopes_PutEnvelope

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
advanced_update query optional string

When true, allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes.
resend_envelope query optional string

When true,
sends the specified envelope again.

Request Body

A container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients.

application/json
schema envelope
Property Type Required
holder string optional
sender object optional
└ uri string optional
└ email string optional
└ userId string optional
└ userName string optional
└ userType string optional
└ accountId string optional
└ ipAddress string optional
└ userStatus string optional
└ accountName string optional
└ loginStatus string optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ membershipId string optional
└ sendActivationEmail string optional
└ activationAccessCode string optional
status string optional
brandId string optional
folders array optional
└ uri string optional
└ name string optional
└ type string optional
└ owner object optional
└ uri string optional
└ email string optional
└ userId string optional
└ userName string optional
└ userType string optional
└ accountId string optional
└ ipAddress string optional
└ userStatus string optional
└ accountName string optional
└ loginStatus string optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ membershipId string optional
└ sendActivationEmail string optional
└ activationAccessCode string optional
└ filter object optional
└ order string optional
└ status string optional
└ expires string optional
└ orderBy string optional
└ folderIds string optional
└ isTemplate string optional
└ searchText string optional
└ toDateTime string optional
└ fromDateTime string optional
└ searchTarget string optional
└ actionRequired string optional
└ folders array optional
└ folderId string optional
└ hasAccess string optional
└ itemCount string optional
└ folderItems array optional
└ status string optional
└ subject string optional
└ folderId string optional
└ folderUri string optional
└ ownerName string optional
└ envelopeId string optional
└ recipients object optional
└ seals array optional
└ agents array optional
└ editors array optional
└ signers array optional
└ notaries array optional
└ witnesses array optional
└ carbonCopies array optional
└ errorDetails object optional
└ participants array optional
└ intermediaries array optional
└ recipientCount string optional
└ inPersonSigners array optional
└ certifiedDeliveries array optional
└ currentRoutingOrder string optional
└ senderName string optional
└ templateId string optional
└ envelopeUri string optional
└ senderEmail string optional
└ templateUri string optional
└ senderUserId string optional
└ sentDateTime string optional
└ is21CFRPart11 string optional
└ recipientsUri string optional
└ senderCompany string optional
└ expireDateTime string optional
└ createdDateTime string optional
└ completedDateTime string optional
└ …1 more object optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ hasSubFolders string optional
└ parentFolderId string optional
└ subFolderCount string optional
└ parentFolderUri string optional
location string optional
workflow object optional
└ resumeDate string optional
└ workflowSteps array optional
└ action string optional
└ itemId string optional
└ status string optional
└ completedDate string optional
└ triggerOnItem string optional
└ triggeredDate string optional
└ delayedRouting object optional
└ rules array optional
└ status string optional
└ resumeDate string optional
└ workflowStepId string optional
└ recipientRouting object optional
└ rules object optional
└ workflowStatus string optional
└ scheduledSending object optional
└ rules array optional
└ delay string optional
└ resumeDate string optional
└ status string optional
└ bulkListId string optional
└ resumeDate string optional
└ currentWorkflowStepId string optional
anySigner string optional
brandLock string optional
powerForm object optional
└ uri string optional
└ name string optional
└ isActive string optional
└ lastUsed string optional
└ createdBy string optional
└ emailBody string optional
└ envelopes array optional
└ timesUsed string optional
└ recipients array optional
└ name string optional
└ email string optional
└ roleName string optional
└ accessCode string optional
└ emailLocked string optional
└ routingOrder string optional
└ recipientType string optional
└ userNameLocked string optional
└ idCheckRequired string optional
└ accessCodeLocked string optional
└ accessCodeRequired string optional
└ idCheckConfigurationName string optional
└ templateRequiresIdLookup string optional
└ senderName string optional
└ templateId string optional
└ powerFormId string optional
└ signingMode string optional
└ emailSubject string optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ instructions string optional
└ powerFormUrl string optional
└ senderUserId string optional
└ templateName string optional
└ maxUseEnabled string optional
└ …5 more object optional
emailBlurb string optional
envelopeId string optional
hasWavFile string optional
purgeState string optional
recipients object optional
└ seals array optional
└ name string optional
└ note string optional
└ tabs object optional
└ ssnTabs array optional
└ zipTabs array optional
└ dateTabs array optional
└ drawTabs array optional
└ listTabs array optional
└ noteTabs array optional
└ textTabs array optional
└ viewTabs array optional
└ emailTabs array optional
└ tabGroups array optional
└ titleTabs array optional
└ numberTabs array optional
└ approveTabs array optional
└ companyTabs array optional
└ declineTabs array optional
└ formulaTabs array optional
└ prefillTabs object optional
└ checkboxTabs array optional
└ fullNameTabs array optional
└ lastNameTabs array optional
└ …19 more object optional
└ status string optional
└ userId string optional
└ roleName string optional
└ faxNumber string optional
└ accessCode string optional
└ statusCode string optional
└ recipientId string optional
└ clientUserId string optional
└ customFields array optional
└ designatorId string optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ noteMetadata object optional
└ rights string optional
└ options array optional
└ routingOrder string optional
└ sentDateTime string optional
└ recipientType string optional
└ totalTabCount string optional
└ completedCount string optional
└ …38 more object optional
└ agents array optional
└ name string optional
└ note string optional
└ email string optional
└ status string optional
└ userId string optional
└ fullName string optional
└ lastName string optional
└ roleName string optional
└ faxNumber string optional
└ firstName string optional
└ accessCode string optional
└ statusCode string optional
└ phoneNumber object optional
└ number string optional
└ countryCode string optional
└ numberMetadata object optional
└ countryCodeMetadata object optional
└ recipientId string optional
└ clientUserId string optional
└ customFields array optional
└ designatorId string optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ nameMetadata object optional
└ rights string optional
└ options array optional
└ noteMetadata object optional
└ rights string optional
└ options array optional
└ …54 more object optional
└ editors array optional
└ name string optional
└ note string optional
└ email string optional
└ status string optional
└ userId string optional
└ fullName string optional
└ lastName string optional
└ roleName string optional
└ faxNumber string optional
└ firstName string optional
└ accessCode string optional
└ statusCode string optional
└ phoneNumber object optional
└ number string optional
└ countryCode string optional
└ numberMetadata object optional
└ countryCodeMetadata object optional
└ recipientId string optional
└ clientUserId string optional
└ customFields array optional
└ designatorId string optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ nameMetadata object optional
└ rights string optional
└ options array optional
└ noteMetadata object optional
└ rights string optional
└ options array optional
└ …53 more object optional
└ signers array optional
└ name string optional
└ note string optional
└ tabs object optional
└ ssnTabs array optional
└ zipTabs array optional
└ dateTabs array optional
└ drawTabs array optional
└ listTabs array optional
└ noteTabs array optional
└ textTabs array optional
└ viewTabs array optional
└ emailTabs array optional
└ tabGroups array optional
└ titleTabs array optional
└ numberTabs array optional
└ approveTabs array optional
└ companyTabs array optional
└ declineTabs array optional
└ formulaTabs array optional
└ prefillTabs object optional
└ checkboxTabs array optional
└ fullNameTabs array optional
└ lastNameTabs array optional
└ …19 more object optional
└ email string optional
└ status string optional
└ userId string optional
└ fullName string optional
└ lastName string optional
└ notaryId string optional
└ roleName string optional
└ faxNumber string optional
└ firstName string optional
└ proofFile object optional
└ isInProofFile string optional
└ hasIdentityAttempts string optional
└ accessCode string optional
└ statusCode string optional
└ delegatedBy object optional
└ Name string optional
└ Email string optional
└ UserId string optional
└ UserAuthorizationId string optional
└ delegatedTo array optional
└ Name string optional
└ Email string optional
└ UserId string optional
└ UserAuthorizationId string optional
└ phoneNumber object optional
└ number string optional
└ countryCode string optional
└ numberMetadata object optional
└ countryCodeMetadata object optional
└ recipientId string optional
└ clientUserId string optional
└ …78 more object optional
└ notaries array optional
└ name string optional
└ note string optional
└ tabs object optional
└ ssnTabs array optional
└ zipTabs array optional
└ dateTabs array optional
└ drawTabs array optional
└ listTabs array optional
└ noteTabs array optional
└ textTabs array optional
└ viewTabs array optional
└ emailTabs array optional
└ tabGroups array optional
└ titleTabs array optional
└ numberTabs array optional
└ approveTabs array optional
└ companyTabs array optional
└ declineTabs array optional
└ formulaTabs array optional
└ prefillTabs object optional
└ checkboxTabs array optional
└ fullNameTabs array optional
└ lastNameTabs array optional
└ …19 more object optional
└ email string optional
└ status string optional
└ userId string optional
└ fullName string optional
└ lastName string optional
└ notaryId string optional
└ roleName string optional
└ faxNumber string optional
└ firstName string optional
└ proofFile object optional
└ isInProofFile string optional
└ hasIdentityAttempts string optional
└ accessCode string optional
└ notaryType string optional
└ statusCode string optional
└ delegatedBy object optional
└ Name string optional
└ Email string optional
└ UserId string optional
└ UserAuthorizationId string optional
└ delegatedTo array optional
└ Name string optional
└ Email string optional
└ UserId string optional
└ UserAuthorizationId string optional
└ phoneNumber object optional
└ number string optional
└ countryCode string optional
└ numberMetadata object optional
└ countryCodeMetadata object optional
└ recipientId string optional
└ …83 more object optional
└ witnesses array optional
└ name string optional
└ note string optional
└ tabs object optional
└ ssnTabs array optional
└ zipTabs array optional
└ dateTabs array optional
└ drawTabs array optional
└ listTabs array optional
└ noteTabs array optional
└ textTabs array optional
└ viewTabs array optional
└ emailTabs array optional
└ tabGroups array optional
└ titleTabs array optional
└ numberTabs array optional
└ approveTabs array optional
└ companyTabs array optional
└ declineTabs array optional
└ formulaTabs array optional
└ prefillTabs object optional
└ checkboxTabs array optional
└ fullNameTabs array optional
└ lastNameTabs array optional
└ …19 more object optional
└ email string optional
└ status string optional
└ userId string optional
└ fullName string optional
└ lastName string optional
└ notaryId string optional
└ roleName string optional
└ faxNumber string optional
└ firstName string optional
└ proofFile object optional
└ isInProofFile string optional
└ hasIdentityAttempts string optional
└ accessCode string optional
└ statusCode string optional
└ witnessFor string optional
└ delegatedBy object optional
└ Name string optional
└ Email string optional
└ UserId string optional
└ UserAuthorizationId string optional
└ delegatedTo array optional
└ Name string optional
└ Email string optional
└ UserId string optional
└ UserAuthorizationId string optional
└ phoneNumber object optional
└ number string optional
└ countryCode string optional
└ numberMetadata object optional
└ countryCodeMetadata object optional
└ recipientId string optional
└ …80 more object optional
└ carbonCopies array optional
└ name string optional
└ note string optional
└ tabs object optional
└ ssnTabs array optional
└ zipTabs array optional
└ dateTabs array optional
└ drawTabs array optional
└ listTabs array optional
└ noteTabs array optional
└ textTabs array optional
└ viewTabs array optional
└ emailTabs array optional
└ tabGroups array optional
└ titleTabs array optional
└ numberTabs array optional
└ approveTabs array optional
└ companyTabs array optional
└ declineTabs array optional
└ formulaTabs array optional
└ prefillTabs object optional
└ checkboxTabs array optional
└ fullNameTabs array optional
└ lastNameTabs array optional
└ …19 more object optional
└ email string optional
└ status string optional
└ userId string optional
└ fullName string optional
└ lastName string optional
└ roleName string optional
└ faxNumber string optional
└ firstName string optional
└ proofFile object optional
└ isInProofFile string optional
└ hasIdentityAttempts string optional
└ accessCode string optional
└ statusCode string optional
└ phoneNumber object optional
└ number string optional
└ countryCode string optional
└ numberMetadata object optional
└ countryCodeMetadata object optional
└ recipientId string optional
└ clientUserId string optional
└ customFields array optional
└ designatorId string optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ …59 more object optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ participants array optional
└ name string optional
└ note string optional
└ email string optional
└ status string optional
└ userId string optional
└ fullName string optional
└ lastName string optional
└ roleName string optional
└ faxNumber string optional
└ firstName string optional
└ accessCode string optional
└ statusCode string optional
└ phoneNumber object optional
└ number string optional
└ countryCode string optional
└ numberMetadata object optional
└ countryCodeMetadata object optional
└ recipientId string optional
└ clientUserId string optional
└ customFields array optional
└ designatorId string optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ nameMetadata object optional
└ rights string optional
└ options array optional
└ noteMetadata object optional
└ rights string optional
└ options array optional
└ …55 more object optional
└ intermediaries array optional
└ name string optional
└ note string optional
└ email string optional
└ status string optional
└ userId string optional
└ fullName string optional
└ lastName string optional
└ roleName string optional
└ faxNumber string optional
└ firstName string optional
└ accessCode string optional
└ statusCode string optional
└ phoneNumber object optional
└ number string optional
└ countryCode string optional
└ numberMetadata object optional
└ countryCodeMetadata object optional
└ recipientId string optional
└ clientUserId string optional
└ customFields array optional
└ designatorId string optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ nameMetadata object optional
└ rights string optional
└ options array optional
└ noteMetadata object optional
└ rights string optional
└ options array optional
└ …54 more object optional
└ recipientCount string optional
└ inPersonSigners array optional
└ name string optional
└ note string optional
└ tabs object optional
└ ssnTabs array optional
└ zipTabs array optional
└ dateTabs array optional
└ drawTabs array optional
└ listTabs array optional
└ noteTabs array optional
└ textTabs array optional
└ viewTabs array optional
└ emailTabs array optional
└ tabGroups array optional
└ titleTabs array optional
└ numberTabs array optional
└ approveTabs array optional
└ companyTabs array optional
└ declineTabs array optional
└ formulaTabs array optional
└ prefillTabs object optional
└ checkboxTabs array optional
└ fullNameTabs array optional
└ lastNameTabs array optional
└ …19 more object optional
└ email string optional
└ status string optional
└ userId string optional
└ hostName string optional
└ notaryId string optional
└ roleName string optional
└ faxNumber string optional
└ hostEmail string optional
└ accessCode string optional
└ notaryHost object optional
└ name string optional
└ note string optional
└ tabs object optional
└ email string optional
└ status string optional
└ userId string optional
└ roleName string optional
└ faxNumber string optional
└ accessCode string optional
└ statusCode string optional
└ recipientId string optional
└ clientUserId string optional
└ customFields array optional
└ designatorId string optional
└ errorDetails object optional
└ nameMetadata object optional
└ noteMetadata object optional
└ routingOrder string optional
└ sentDateTime string optional
└ emailMetadata object optional
└ …45 more object optional
└ signerName string optional
└ statusCode string optional
└ recipientId string optional
└ signerEmail string optional
└ clientUserId string optional
└ customFields array optional
└ designatorId string optional
└ …74 more object optional
└ certifiedDeliveries array optional
└ name string optional
└ note string optional
└ email string optional
└ status string optional
└ userId string optional
└ fullName string optional
└ lastName string optional
└ roleName string optional
└ faxNumber string optional
└ firstName string optional
└ proofFile object optional
└ isInProofFile string optional
└ hasIdentityAttempts string optional
└ accessCode string optional
└ statusCode string optional
└ phoneNumber object optional
└ number string optional
└ countryCode string optional
└ numberMetadata object optional
└ countryCodeMetadata object optional
└ recipientId string optional
└ clientUserId string optional
└ customFields array optional
└ designatorId string optional
└ errorDetails object optional
└ message string optional
└ errorCode string optional
└ nameMetadata object optional
└ rights string optional
└ options array optional
└ …57 more object optional
└ currentRoutingOrder string optional
allowMarkup string optional
envelopeUri string optional
expireAfter string optional
hasComments string optional
messageLock string optional
…59 more object optional

Responses

200

Successful response.
400

Error encountered.
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events

Gets the envelope audit events for the specified envelope.

operationId: AuditEvents_GetAuditEvents

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages

Returns images of the pages in a document for display based on the parameters that you specify.

operationId: Pages_GetPageImages

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
documentId path required string

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API,
you specify the documentId yourself.
Typically the first document has the ID
1, the second document 2, and so on,
but you can use any numbering scheme
that fits within a 32-bit signed integer
(1 through 2147483647).

Tab objects have a documentId property
that specifies the document on which to place
the tab.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
count query optional string

The maximum number of results to return.
dpi query optional string

The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.
max_height query optional string

Sets the maximum height of the returned images in pixels.
max_width query optional string

Sets the maximum width of the returned images in pixels.
nocache query optional string

When true, using cache is disabled and image information is retrieved from a database. True is the default value.
show_changes query optional string

When true, changes display in the user interface.
start_position query optional string

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages
DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}

Deletes a page from a document in an envelope based on the page number.

operationId: Pages_DeletePage

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
documentId path required string

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API,
you specify the documentId yourself.
Typically the first document has the ID
1, the second document 2, and so on,
but you can use any numbering scheme
that fits within a 32-bit signed integer
(1 through 2147483647).

Tab objects have a documentId property
that specifies the document on which to place
the tab.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
pageNumber path required string

The page number being accessed.

Responses

200

Successful response.
400

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

Returns an image of a page in a document for display.

operationId: Pages_GetPageImage

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
documentId path required string

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API,
you specify the documentId yourself.
Typically the first document has the ID
1, the second document 2, and so on,
but you can use any numbering scheme
that fits within a 32-bit signed integer
(1 through 2147483647).

Tab objects have a documentId property
that specifies the document on which to place
the tab.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
pageNumber path required string

The page number being accessed.
dpi query optional string

Sets the dots per inch (DPI) for the returned image.
max_height query optional string

Sets the maximum height for the page image in pixels. The DPI is recalculated based on this setting.
max_width query optional string

Sets the maximum width for the page image in pixels. The DPI is recalculated based on this setting.
show_changes query optional string

When true, changes display in the user interface.

Responses

200

Successful response.
400

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

Rotates page image from an envelope for display. The page image can be rotated to the left or right.

operationId: Pages_PutPageImage

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
documentId path required string

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API,
you specify the documentId yourself.
Typically the first document has the ID
1, the second document 2, and so on,
but you can use any numbering scheme
that fits within a 32-bit signed integer
(1 through 2147483647).

Tab objects have a documentId property
that specifies the document on which to place
the tab.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
pageNumber path required string

The page number being accessed.

Request Body

#/components/requestBodies/pageRequest

Responses

200

Successful response.
400

Error encountered.
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification

Retrieves the envelope notification, reminders and expirations, information for an existing envelope.

operationId: Notification_GetEnvelopesEnvelopeIdNotification

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification

This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope.

Note that this request only specifies when notifications are sent; it does not initiate sending of email messages.

operationId: Notification_PutEnvelopesEnvelopeIdNotification

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Request Body

application/json
schema envelopeNotificationRequest
Property Type Required
reminders object optional
└ reminderDelay string optional
└ reminderEnabled string optional
└ reminderFrequency string optional
expirations object optional
└ expireWarn string optional
└ expireAfter string optional
└ expireEnabled string optional
useAccountDefaults string optional

Responses

200

Successful response.
400

Error encountered.
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image

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

operationId: Recipients_GetRecipientInitialsImage

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
recipientId path required string

A local reference used to map
recipients to other objects, such as specific
document tabs.

A recipientId must be
either an integer or a GUID,
and the recipientId must be
unique within an envelope.

For example, many envelopes assign the first recipient
a recipientId of 1.
include_chrome query optional string

The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.

Responses

200

Successful response.
400

Error encountered.
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image

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.

operationId: Recipients_PutRecipientInitialsImage

Parameters

Name In Required Type Description
accountId path required string

The external account number (int) or account ID GUID.
envelopeId path required string

The envelope’s GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
recipientId path required string

A local reference used to map
recipients to other objects, such as specific
document tabs.

A recipientId must be
either an integer or a GUID,
and the recipientId must be
unique within an envelope.

For example, many envelopes assign the first recipient
a recipientId of 1.

Responses

200

Successful response.
400

Error encountered.
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image
Load more endpoints