DOdocusign
EnvelopeViews

Returns a URL to the Docusign eSignature web application.

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

  • How to embed the Docusign UI in your app
post/v2.1/accounts/{accountId}/views/console

Request

Path parameters

accountIdstring required

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

Request body

envelopeIdstring

The ID of an envelope. If the envelope has been sent, the endpoint returns a URL for a view of the documents. If the envelope has not yet been sent, the endpoint returns a URL for the sender view.

This property is optional. If no value is provided, the endpoint returns a URL for the front page of the demo UI.

returnUrlstring

The URL to which the user should be redirected. This is only used when the envelopeId is specified as a draft envelope. In this case, the endpoint returns a URL for the sender view. When the user exits the sender view, they will be redirected to the returnUrl value. If no value is provided, there is no option to leave the sender view.

In other cases, the user is not redirected out of the console view.

Response

Successful response.

urlstring

The view URL to be navigated to.

Changes

No recorded changes to this operation across all 39 revisions of this API.