Update onboarding flow

Changes flow-level state for the signed-in user: how the flow is displayed, and which step is active.
Moves the pointer between steps; it does not change whether any individual step is complete.

Path Params
string
required

Onboarding flow slug.

Body Params

Onboarding state update.

Request to update onboarding UI state for a flow.

string
enum
required

Display state for an onboarding flow.

Allowed:
string | null

Stable onboarding step key for the active step, if selected.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json