---
title: "Update Onboarding Prefs"
method: PATCH
path: "/v1/users/me/onboarding"
tags: ["Users"]
---

# Update Onboarding Prefs

`PATCH /v1/users/me/onboarding`

## Request

- Base URL: `https://api.call2me.app`
- URL: `https://api.call2me.app/v1/users/me/onboarding`
- Auth: HTTP bearer

Store the user's own view of the getting-started checklist.

Kept in `users.metadata->onboarding` rather than its own columns: this is
UI preference, not domain data, and it changes shape whenever the
checklist does.

## Request body

- OnboardingPrefs: Which getting-started steps the user has dealt with themselves. The checklist marks a step done by MEASURING it (an agent exists, a call happened). That is right for tracking real progress but wrong as the only rule: someone who will never add a knowledge base, or who tops up by invoice, is stuck looking at a list they cannot finish. These let them tick a step off or hide it — their judgement, not ours.
  - `dismissed` string[], nullable
  - `completed` string[], nullable
  - `hidden` boolean, nullable

## Response `200`

Successful Response

- object

## Other responses

- `422`: Validation Error

---

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