Cancel running workflow instance | Docusign

This operation cancels a running Workflow Builder workflow instance by its unique identifier (instanceId). Once canceled, the workflow instance will no longer continue executing any remaining steps.

Use Cases:

Stopping a workflow execution when it is no longer needed or relevant
Manually intervening in a workflow to prevent it from reaching completion if conditions change

Key Features:

Immediate Termination: Ensures the workflow instance no longer processes subsequent steps
Clear Feedback: Returns a confirmation message including both the instance and workflow identifiers

Authentication

AuthorizationBearer

OAuth2 authentication.

Demo:
- authorizationUrl: https://account-d.docusign.com/oauth/auth
- tokenUrl: https://account-d.docusign.com/oauth/token
Production:
- authorizationUrl: https://account.docusign.com/oauth/auth
- tokenUrl: https://account.docusign.com/oauth/token

Path parameters

accountIdstringRequiredformat: "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$"

The unique identifier of the account.

workflowIdstringRequiredformat: "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$"

A universally unique identifier (UUID) in standard 8-4-4-4-12 format.

instanceIdstringRequiredformat: "uuid"

Unique identifier for the workflow instance

Response

A message confirming the instance was canceled, including the instance and workflow IDs

messagestringOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error