# onboarding

> Service-selection onboarding, checklist, trial and readiness.

Service-selection onboarding, checklist, trial and readiness.

| Method | Path | Operation | Scope | Test mode |
|---|---|---|---|---|
| GET | `/v1/onboarding` | `onboarding_get`: Onboarding progress and next step | `org:read` | - |
| PATCH | `/v1/onboarding` | `onboarding_update`: Save the goal and where the wizard stopped | `org:write` | - |
| POST | `/v1/onboarding/business-profile` | `onboarding_business_profile`: Set the business type (and optional basics) and run the restricted-category gate | `org:write` | - |
| GET | `/v1/onboarding/business-types` | `onboarding_business_types`: The business types the wizard offers, with the restricted ones marked | `org:read` | - |
| DELETE | `/v1/onboarding/demo-chat` | `onboarding_demo_chat_reset`: Start the demo chat again | `org:write` | - |
| GET | `/v1/onboarding/demo-chat` | `onboarding_demo_chat_get`: The labelled demo customer chat for the "Try it" step | `org:read` | - |
| POST | `/v1/onboarding/demo-chat/reply` | `onboarding_demo_chat_reply`: Send the reply to the demo customer | `org:write` | - |
| GET | `/v1/onboarding/features` | `onboarding_features_get`: The features this business shows in the sidebar | `org:read` | - |
| PUT | `/v1/onboarding/features` | `onboarding_features_set`: Choose the features this business shows in the sidebar | `org:write` | - |
| POST | `/v1/onboarding/import-website` | `onboarding_import_website`: Crawl a website into a knowledge draft | `org:write` | - |
| GET | `/v1/onboarding/readiness` | `onboarding_readiness`: Setup health checklist | `org:read` | - |
| GET | `/v1/onboarding/reminders` | `onboarding_reminders_list`: My onboarding reminders | `org:read` | - |
| POST | `/v1/onboarding/reminders` | `onboarding_reminders_create`: Remind me to finish setup | `org:write` | - |
| DELETE | `/v1/onboarding/reminders/{reminder_id}` | `onboarding_reminders_cancel`: Cancel a reminder | `org:write` | - |
| POST | `/v1/onboarding/resume-link` | `onboarding_resume_link`: Send myself a link to continue setup on a computer | `org:write` | - |
| POST | `/v1/onboarding/sample-data` | `onboarding_sample_data`: Seed sample contacts for a demo | `org:write` | - |
| PUT | `/v1/onboarding/services` | `onboarding_set_services`: Set the selected services | `org:write` | - |
| POST | `/v1/onboarding/signup-simulation` | `onboarding_simulate_signup`: Development only: simulate the Facebook sign-up window | `channels:write` | - |
| GET | `/v1/onboarding/starter-pack` | `onboarding_starter_pack`: What the starter pack for a business type will load, all switched off | `org:read` | - |
| POST | `/v1/onboarding/steps/{step_key}/complete` | `onboarding_complete_step`: Mark a step done or skipped | `org:write` | - |
| POST | `/v1/onboarding/trial/start` | `onboarding_trial_start`: Start the 14-day Growth trial | `billing:write` | - |
| GET | `/v1/onboarding/tutorials` | `onboarding_tutorials`: Tutorials per service | `org:read` | - |

Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`.
