EnvelopeViews: createCorrect

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

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

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. (For 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

returnUrlstring

The url used after correct/send view session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your app. 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

A 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> 
}} />