---
title: "Update current user onboarding state"
method: PATCH
path: "/v1/users/me/onboarding"
tags: ["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

- UpdateOnboardingDto
  - `globalCompleted` boolean: Mark global onboarding as completed
  - `globalSkipped` boolean: Skip global onboarding (also marks it as completed)
  - `globalLastStepSeen` number: Index of the last onboarding step the user has seen
  - `completeFeatureTour` string: Slug of a feature tour to mark as completed (merged into featureToursCompleted map)
  - `reset` boolean: Reset onboarding to initial state (step 0, not completed)

## Response `200`

Onboarding state updated

---

[API](https://skmtc.dev/sprixen/apis/sprixen-api.md) · [All operations](https://skmtc.dev/sprixen/apis/sprixen-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sprixen/apis/sprixen-api/revisions/6c0c57f6da58?raw)