Onboarding

Update current user onboarding state

patch/v1/users/me/onboarding

Request

  • Base URL: https://api.sprixen.com
  • URL: https://api.sprixen.com/v1/users/me/onboarding
  • Auth: bearer (a scheme the document does not define)

Request body

globalCompletedboolean

Mark global onboarding as completed

globalSkippedboolean

Skip global onboarding (also marks it as completed)

globalLastStepSeennumber

Index of the last onboarding step the user has seen

completeFeatureTourstring

Slug of a feature tour to mark as completed (merged into featureToursCompleted map)

resetboolean

Reset onboarding to initial state (step 0, not completed)

Example request

{
  "globalCompleted": true,
  "globalLastStepSeen": 2,
  "completeFeatureTour": "map-builder",
  "reset": true
}

Response

Onboarding state updated

Changes

No recorded changes to this operation across all 1 revision of this API.