Skip to main content
POST
Cancel a workflow run

Authorizations

Authorization
string
header
required

OAuth Bearer access tokens or Flow API keys with the required Flow scope families for the route.

Headers

Idempotency-Key
string
required

Required idempotency key for retry-safe workflow actions. The same key plus the same request fingerprint replays the accepted result with meta.replayed=true in the response body. Stored HTTP responses for create requests in the customer API retain their original success status, including 201 Created and 202 Accepted. An in-progress key returns 409 idempotency_key_in_progress. A reused key with a different request fingerprint returns 409 idempotency_key_reused.

Maximum string length: 255

Path Parameters

workflowRunId
string
required

Exact org-scoped runKey returned by the API (for example RUN-123), or the run's universally unique identifier (UUID). Preserve the returned key, including a historical FLOW-RUN-123 prefix.

Body

application/json
data
object
required

Response

Workflow run cancellation control receipt.

data
object
required

Cooperative cancellation request receipt. Status is the run state observed at response time, not a promise of cancellation. Read the run for its final outcome.

meta
object
required