---
title: "Update onboarding state"
method: POST
path: "/onboarding-state"
tags: ["accounts"]
---

# Update onboarding state

`POST /onboarding-state`

## Request body

- UpdateOnboardingStateRequestBody
  - `path` 'agent' | 'app'
  - `pricing_page_url` string, nullable
  - `track` 'catalog' | 'single_plan'
  - `website_url` string, nullable

## Response `200`

OK

- object
  - `data` GetOnboardingStateResp, required
    - `environment_id` string, nullable
    - `milestones` OnboardingMilestoneView[], required
      - `id` 'evaluated' | 'implemented', required
      - `missing` OnboardingRequirement[], required
      - `progress` number, double, required
      - `reached_at` string, date-time, nullable
    - `path` 'agent' | 'app'
    - `requirements` OnboardingRequirementView[], required
      - `blocked_by` OnboardingRequirement[]
      - `id` 'connect_billing' | 'create_api_key' | 'first_flag_check' | 'import_companies' | 'model_packaging' | 'send_events', required
      - `satisfied_by` string
      - `status` 'available' | 'blocked' | 'complete', required
    - `suggested_next` OnboardingRequirement[], required
    - `track` 'catalog' | 'single_plan'
  - `params` object, required — Input parameters

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `500` — Server error

---

[API](https://skmtc.net/schematichq/apis/schematic-api.md) · [All operations](https://skmtc.net/schematichq/apis/schematic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/schematichq/schematic-api/revisions/2eb9f9880ef6/schema)