---
title: "Patch Onboarding"
method: PATCH
path: "/me/onboarding"
tags: ["onboarding"]
---

# Patch Onboarding

`PATCH /me/onboarding`

## Request

- Base URL: `https://api.callboard.fm` (the document declares no server; this is the origin it was published from)
- URL: `https://api.callboard.fm/me/onboarding`
- Auth: none declared

Partial update to onboarding state + market profile.

Called on every step's "Continue" with the step's slice of state. The
frontend can also use this to bump the current_step on Save & Exit.

When status flips to 'complete', this also writes
publicMetadata.onboarding_complete=true on the Clerk user so the
middleware will let them past /onboarding on their next request.

## Headers

- `authorization` string, nullable

## Request body

- OnboardingPatch
  - `status` string, nullable
  - `current_step` string, nullable
  - `market_profile` MarketProfilePatch
    - `primary_market` object, nullable
    - `rooms` object[], nullable
    - `genres_selected` string[], nullable
    - `genres_excluded` string[], nullable
    - `guarantee_lo` integer, nullable
    - `guarantee_hi` integer, nullable
    - `lead_time_days` integer, nullable
    - `secondary_markets` object[], nullable
    - `radius_miles` integer, nullable
    - `digest_day` integer, nullable
    - `digest_hour` integer, nullable
    - `digest_tz` string, nullable
    - `digest_recipients` string[], nullable
    - `listener_floor` integer, nullable
    - `listener_ceiling` integer, nullable
  - `exited` boolean, nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

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