EnvelopeViews: createConsole

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

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

Information Security notice: This method provides full administrator access to the account.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Request Body

consoleViewRequest

Responses

CodeDescriptionReference
201

Successful response.

EnvelopeViews
400

Error encountered.

errorDetails

SDK Method

Envelopes::createConsoleView

Definitions

consoleViewRequest

The request object for the EnvelopeViews::createConsole method.

envelopeIdstring

The id of the envelope.

returnUrlstring

(Optional) The URL to which the user should be redirected after the console view session has ended.

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

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.

EnvelopeViews

Embedding Envelope views

urlstring

The view URL to be navigated to.

Examples

Getting a Console View URL and Setting a Return URL

The response contains the URL of the the account's cosole.

The request body contains a returnUrl. This is the URL that the DocuSign platform will redirect the user to when the view is closed.

Request
{
  "returnUrl": "https://dsapp.example.com/return/from/console/view"
}
Response
{
  "url": "https://demo.docusign.net/Member/StartInSession.aspx?StartConsole=1&t=644ea697-2541-46ea-a8a5-d95a5c23340b&accountid=624e3e00-36cb-4bcf-a4af-43918c520dab"
}
Generic JSON Request/Response

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

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