Cancel active workflow work and optionally linked children

POST

workflows

{id}

cancel

Error

A valid request URL is required to generate request examples

Headers

Idempotency-Key

string

required

Required on every mutating request. A double-clicked Retry, or a proxy retrying a POST, must not enqueue the job twice. Keys are retained long enough to cover a client retry window and the response is replayed verbatim.

Path Parameters

string

required

Body

application/json

propagate_children

boolean

default:true

Response

200

Bounded cancellation receipt

Error

A valid request URL is required to generate request examples