EnvelopeViews: createSender

Returns a URL that enables you to embed the sender view of the DocuSign UI in your applications.

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.

For the best user experience, don't use an iFrame. For iOS devices DocuSign recommends using a WebView.

Multiple solutions are available for maintaining your client state. See the Maintaining State section of the Embedded Signing introduction.

After the user has completed the sending view, the browser is redirected to the returnUrl supplied.

By default, if the envelope already contains one or more documents, DocuSign will initially show the document tagging view when you redirect to the URL.

To start with the envelope's recipients and documents view instead, examine the URL in the method's response. Then change the query parameter from send=1 to send=0 to start with the recipients/documents view.

Note: You can revoke the URL by making the DELETE call to the same URL with no request body.

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.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

envelopeIdstring

The envelope's GUID.

Example: 93be49ab-afa0-4adf-933c-f752070d71ec

Request Body

returnUrlRequest

Responses

CodeDescriptionReference
201

Successful response.

EnvelopeViews
400

Error encountered.

errorDetails

SDK Method

Envelopes::createSenderView

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

returnUrlRequest

The request body for the EnvelopeViews::createSender method.

returnUrlstring

(Optional) The URL to which the user should be redirected after the sending session is complete.

Maximum Length: 500 characters. If the returnUrl exceeds this limit, the user is redirected to a truncated URL.

EnvelopeViews

Embedding Envelope views

urlstring

The view URL to be navigated to.

Examples

Generic JSON Request/Response

Request
{
  "returnUrl": "sample string 1"
}
Response
{
  "url": "sample string 1"
}
Generic XML Request/Response

Request
<returnUrlRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <returnUrl>sample string 1</returnUrl>
</returnUrlRequest> 
Response
<viewUrl xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <url>sample string 1</url>
</viewUrl> 
}} />