PUT
Update User Onboarding State

Authorizations

Authorization
string
header
required

An EESI API key (sk-eesi-...) or a Clerk session token.

Headers

authorization
string | null
X-API-Key
string | null

Body

application/json

Partial update merged into the stored state.

Scalars overwrite when supplied; list entries are unioned into the stored lists, so concurrent updates (e.g. two tabs marking different tooltips) don't drop each other's items.

completed_at
string<date-time> | null
skipped
boolean | null
seen_tooltips
string[] | null
completed_actions
string[] | null

Response

Successful Response

Per-user onboarding state, stored under UserConfigurationKey.ONBOARDING.

Server-authoritative replacement for the browser-localStorage onboarding store, so the post-signup gate and one-time tooltips hold across devices.

completed_at
string<date-time> | null
skipped
boolean
default:false
seen_tooltips
string[]
completed_actions
string[]