docusign.envelope-views.delete-envelope-correct-view

This API method is obsolete. Your application should not call it. It acts as a null operation.

Revokes the correction view URL to the Envelope UI.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
envelopeid	string	Yes	—	The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
beginontagger	string	No	—	—
returnurl	string	No	—	(Required) The URL to which the user should be redirected after the view session has ended. Maximum Length: 470 characters. If the returnUrl exceeds this limit, the user is redirected to a truncated URL Be sure to include https:// in the URL or redirecting might fail on some browsers. When Docusign redirects to this URL, it will include an event query parameter that your app can use: * 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.
suppressnavigation	string	No	—	Specifies whether the window is displayed with or without dressing.
viewurl	string	No	—	—

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
envelopeid	string	Yes	—	The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
beginontagger	string	No	—	—
returnurl	string	No	—	(Required) The URL to which the user should be redirected after the view session has ended. Maximum Length: 470 characters. If the returnUrl exceeds this limit, the user is redirected to a truncated URL Be sure to include https:// in the URL or redirecting might fail on some browsers. When Docusign redirects to this URL, it will include an event query parameter that your app can use: * 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.
suppressnavigation	string	No	—	Specifies whether the window is displayed with or without dressing.
viewurl	string	No	—	—
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.envelope-views.delete-envelope-correct-view",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "envelopeid": "value"
  }
}