DocuSign Momentum 2018DocuSign Momentum 2018

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 NameValueDescription
Path Parameters
accountIdstring

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

envelopeIdstring

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

Request Body

returnUrlRequest

Responses

CodeDescriptionReference
201

Successful response.

EnvelopeViews
400

Error encountered.

errorDetails

SDK Method

Envelopes::createSenderView

Definitions

errorDetails
returnUrlRequest
EnvelopeViews

Examples

Generic JSON Request/Response
Generic XML Request/Response