Workflows

Cancel a running approval

Recalls a run that is still in progress — every pending task is superseded and no further decision can move it. Only the member who started the run, or a monitor (workflow:manage), may cancel it, and only while it is still running. This does not undo a decision already recorded.

Examples

  • Never mind, pull that request back POST /api/v1/rest/workflow/instances/11111111-2222-4333-8444-555555555555/cancel
post/api/v1/rest/workflow/instances/{id}/cancel

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/workflow/instances/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring uuid required

From workflow_get_instance or workflow_list_instances.

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Response

Done. data is the tool’s own answer.

oktrue required
dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.