POST
Take a flow live so it starts enrolling and sending

Authorizations

Authorization
string
header
required

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

Idempotency-Key
string
required

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

marketingFlowId
string
required

Body

application/json

Takes no parameters, and a body is REFUSED rather than ignored so a client posting {"status":"archived"} here cannot read the 200 as agreement. THIS IS THE CALL THAT STARTS MAILING PEOPLE. Everything before it is configuration; this is what lets the trigger matcher find the flow and begin enrolling real contacts into a program that sends. A flow with no published version is 409 no_published_version rather than a live flow enrolling contacts into nothing.

Response

Success

data
object