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, their browser is redirected to the returnUrl you 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.

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
accountId string

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

envelopeId string

The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec

Request Body

Responses

Code Description Reference
201 Created Successful response.
400 Bad Request Error encountered.

SDK Method

Envelopes::createSenderView

Definitions Expand All | Collapse All

EnvelopeViews

Embedding Envelope views

url string

The view URL to be navigated to.

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

returnUrlRequest

The request body for the EnvelopeViews: createSender method.

returnUrl string

Your app's return url that the user will be redirected to after sending the envelope or completing the sending/tagging view. Query parameters envelopeId and event will be added to the URL. The event parameter values:

  • Send (the user sent the envelope)
  • Save (the user saved the envelope, it is still a draft)
  • Cancel (the user canceled the sending transaction)
  • Error (there was an error during the send operation)
  • SessionEnd (the sending session ended before the user completed a different action)

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>