Onboarding

Update onboarding progress

Persist the current user's onboarding progress: the IDs of completed steps and whether the checklist is hidden.

put/onboarding

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

completedStepIdsstring[] required

IDs of the onboarding steps the user has completed

hiddenboolean required

Whether the user has hidden the onboarding checklist

Example request

{
  "completedStepIds": [
    "create-assistant",
    "start-chat"
  ]
}

Response

Onboarding progress successfully updated

completedStepIdsstring[] required

IDs of the onboarding steps the user has completed

hiddenboolean required

Whether the user has hidden the onboarding checklist

welcomeVideoSeenAtstring date-time nullable required

When the user first dismissed the welcome video

Example response

{
  "completedStepIds": [
    "create-assistant",
    "start-chat"
  ],
  "welcomeVideoSeenAt": "2026-08-05T12:00:00.000Z"
}

Changes

No recorded changes to this operation across all 51 revisions of this API.