Skip to main content
POST
Add a step to a cancel flow

Path Parameters

Body Parameters

Example Request

Response

Step order is 0-indexed. If a step already exists at the given step_order, existing steps are shifted forward automatically.

Authorizations

Authorization
string
header
required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Path Parameters

id
string<uuid>
required

Body

application/json
step_order
integer
required
Required range: x >= 1
step_type
enum<string>
required
Available options:
survey,
offer,
confirmation
config
object

Step-type-specific configuration (survey options, offer details, ...). Defaults to {}.

Response

Step created.

id
string<uuid>
flow_id
string<uuid>
step_order
integer
step_type
enum<string>
Available options:
survey,
offer,
confirmation
config
any

Step-type-specific configuration (arbitrary JSON).

created_at
string<date-time>