EnvelopeViews: createConsole

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

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
accountId string

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

Request Body

Responses

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

SDK Method

Envelopes::createConsoleView

Definitions Expand All | Collapse All

EnvelopeViews

Embedding Envelope views

url string

The view URL to be navigated to.

consoleViewRequest

envelopeId string

The envelope ID of the envelope status that failed to post.

returnUrl string

The URL to be redirected to after the console view session has ended.

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.

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>