Skip to main content
PUT
Replace a flow
The body is the whole flow: the recipes you send replace the existing references entirely, so send the full list even when adding one. The identifier doesn’t change. This is what makes a flow the right thing to hard-code in your product - you can retire a recipe, add a shadow one beside it, or reorder the references without a deploy on your side. Replacing a flow that does not exist answers 404 rather than creating it.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

flow_id
string
required

The flow identifier.

Example:

"flo_01jc0t6fwwfgfsq1md24mhyztj"

Body

application/json
name
string
required

The moment this flow guards.

Maximum string length: 128
Example:

"signup"

recipes
string[]
required

The recipes that run when this flow is evaluated. At least one is required, and each must exist.

Minimum array length: 1
Example:

Response

OK

id
string
required

The flow identifier. Pass it as flow_id when you evaluate.

Example:

"flo_01jc0t6fwwfgfsq1md24mhyztj"

name
string
required
Example:

"signup"

recipes
string[]
required
Example: