Skip to main content
POST
Turn a flow on (admins)

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

flow_id
string
required

Body

application/json
person_confirmed
boolean
required

true: the person saw this preview (its matches, first run and steps) and said to turn it on. Never set it without asking them.

preview_token
string
required
mode
enum<string> | null

For a flow that has run before (the preview's has_run_before): continue keeps its run history, so records it already ran for don't run again; fresh starts over, as if it never ran. Required then, as in the app. On a flow that is already on, only fresh is accepted: it restarts the run history.

Available options:
continue,
fresh

Response

200 - application/json

Successful Response

editor_url
string
required

The flow in Agent Studio

enabled
boolean
required
flow_id
string
required
name
string
required
trigger
string
required

The audience in words

version
integer
required
nodes
Nodes · object

step id -> node id in the editor