Cancel a running run (tenant:flows:write|admin; a scoped flow's run with the owning module's manage)
POST /api/flows/v1/runs/{id}/cancel
Module: Flows · operationId: cancelFlowRun · Tag: Runs · Auth: access token (Authorization: Bearer <accessToken>)
Waiting nodes are cancelled; a node that is calling a module finishes its call, but nothing follows it. Who may change the flow may cancel its runs (a scoped flow: who its module lets manage the scope).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string (uuid) | yes |
Responses
- 204 Cancelled
- 401 Missing, invalid or expired token (no body).
- 403 The token lacks the permission or has no active tenant (
forbidden). Also:person_required(a service-account key on personal flows or the task inbox),live_test_forbidden,forbidden_grant,starter_excluded. (application/json) - 404 The record does not exist in the token's tenant – or it belongs to a scope the caller may not view (a scoped flow stays hidden). (
application/json) - 409 The state does not allow it: version_conflict (reload), no_changes, archived, key_taken, flow_disabled, flow_tripped, task_closed, run_finished. (
application/json) - 503 A dependency is not available:
scope_unavailable(the module that owns a flow's scope did not answer who may see and manage it – nothing of a scoped flow is shown or changed),identity_unavailable(HR),ai_unavailable,ai_failed. (application/json)
Example request
curl -X POST 'https://api.mbcom.cloud/api/flows/v1/runs/3f2b8c1e-7d4a-4e9b-9c2a-5b1d6e8f0a12/cancel' \
-H "Authorization: Bearer $ACCESS_TOKEN"