Sign in
preferences

Update Onboarding Guide State

Persist authenticated onboarding guide state for this user/workspace.

patch/v1/preferences/onboarding/{guide_key}

Path parameters

guide_keystring required

Request body

workspace_idstring uuid required
status'auto_started' | 'completed' | 'skipped' required

Response

Successful Response

guide_keystring required
workspace_idstring uuid required
status'not_started' | 'auto_started' | 'completed' | 'skipped' required
auto_start_allowedboolean required
first_auto_started_atstring date-time nullable
last_started_atstring date-time nullable
completed_atstring date-time nullable
skipped_atstring date-time nullable

Changes