EnvelopeViews: createCorrect

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

Important: Due to screen space issues, iFrames should not be used for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView.

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 access to the sending account. When you use this view, the current user has full access to the account. If the account has administrative privileges, then this method also provides administrator access.

If your use case needs to enable a sender to update a draft envelope before it is sent or make other changes, take one of the following steps:

  • Configure each sender to have their own individual user account to use this API method.
  • Enhance your API integration so that this method is not needed. Your integration can create the tabs, recipients, and other envelope settings as needed.

Request

HTTP request

POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

envelopeIdstring

The envelope's GUID.

Example: 93be49ab-afa0-4adf-933c-f752070d71ec

Request Body

correctViewRequest

Responses

CodeDescriptionReference
201

Successful response.

EnvelopeViews
400

Error encountered.

errorDetails

SDK Method

Envelopes::createCorrectView

Definitions

correctViewRequest

The request body for the EnvelopeViews::createCorrect method.

returnUrlstring

(Optional) The URL to which the user should be redirected after the correct/send view session has ended. DocuSign redirects to this URL and includes an event parameter that your app can use.

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

The event parameters returned are:

  • send (user corrected and sent the envelope)
  • save (user saved the envelope)
  • cancel (user canceled the transaction.)
  • error (there was an error when performing the correct or send)
  • sessionEnd (the session ended before the user completed a different action)
Note: Include https:// in the URL or the redirect might not succeed on some browsers.

suppressNavigationstring

Specifies whether the window is displayed with or without dressing.

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

Generic JSON Request/Response

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

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