Skip to main content
POST
Submit a step response in a session

Path Parameters

Body Parameters

Example Request

Response

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
response
any
required

Step-type-specific response payload (e.g. selected survey reason, offer accepted flag).

step_index
integer
Required range: x >= 0

Response

Step processed; indicates the next step or completion.

session_id
string<uuid>
status
enum<string>
Available options:
in_progress,
completed,
cancelled,
saved
next_step
object
saved_by_offer
boolean
completed
boolean