---
title: "Update Onboarding"
method: POST
path: "/api/onboarding/update"
tags: ["onboarding", "onboarding"]
---

# Update Onboarding

`POST /api/onboarding/update`

## Request

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

Save onboarding progress.

Can update product, step, goal, and/or data.
Merges data with existing data (doesn't replace).

## Request body

- OnboardingUpdateRequest: Update onboarding progress.
  - `product` 'livechat' | 'social-boost' | 'ai-communication', nullable
  - `step` integer, nullable
  - `goal` 'get_leads' | 'respond_faster' | 'automate' | 'boost_engagement' | 'manage_inbox' | 'reach_people' | 'capture_leads' | 'nurture', nullable
  - `data` object, nullable

## Response `200`

Successful Response

- OnboardingUpdateResponse: Response after updating onboarding.
  - `success` boolean, required
  - `status` 'pending' | 'in_progress' | 'skipped' | 'completed', required
  - `product` 'livechat' | 'social-boost' | 'ai-communication', nullable
  - `step` integer

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/dialogbrain/apis/dialogbrain-v2-api-gateway.md) · [All operations](https://skmtc.dev/dialogbrain/apis/dialogbrain-v2-api-gateway/llms.txt) · [OpenAPI document](https://skmtc.dev/dialogbrain/apis/dialogbrain-v2-api-gateway/revisions/77bef09a9209?raw)