Skip to navigation

RequestCorrectToken

View as Markdown

This call returns a token to place a user in a web session in Advanced Correct mode on an envelope.

// Create and send envelope as shown in linked code
DocuSignWeb.EnvelopeStatus status = <create and send envelope>;
// Request the token with the envelope ID and a return URL
String token = _apiClient.RequestCorrectToken(status.EnvelopeID, true, baseURL);
// Display token
Console.WriteLine("The token returned is {0}", token);

Schema

NameSchema TypeDescription
EnvelopeIDStringIdentifies the envelope to be corrected.
SuppressNavigationBooleanSets whether the window is displayed with or without dressing.
ReturnURLStringIdentifies the return point after correcting the envelope. The URL will have an event passed to it as a query parameter. The parameter will be named “event”, see “In-session sending events” below for description of the valid events. The Docusign Envelope Id will also be returned in the “envelopeId” parameter.Important – You must include HTTPS:// in the URL or the redirect might be blocked by some browsers.

In-Session Sending Events

Events returned on the ReturnURL as a query string parameter. The event is sent in the parameter named “event”. The ReturnURL is called with the event on any completion state of the envelope send. Valid events can be found in the schema type InSessionSendEvent in the Docusign API XSD.

EventDescription
SendUser sends the envelope.
SaveUser saves a draft of the envelope.
CancelUser cancels the sending transaction. No envelope ID returned.
ErrorError performing the send.
SessionEndSending session ended before the user completed.