Retire a flow and cancel every run in flight
Authorizations
A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.
Headers
A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.
Path Parameters
Body
Takes no parameters, and a body is refused rather than ignored. IRREVERSIBLE AND WIDER THAN IT LOOKS. There is no transition out of archived, and the same transaction CANCELS EVERY RUN IN FLIGHT, so a merchant with a large cohort mid-journey loses all of them at once and no later call brings them back. Those contacts do not resume. That is why it needs write_marketing_flows:delete on top of write_marketing_flows, even though it is a POST and destroys no row: the qualifier names an irreversible OPERATION rather than the DELETE verb. A key that manages a merchant's programs day to day should hold the write half only, and will get 403 here. Use pause if you want the flow to stop and the people already in it to finish.
Response
Success
