Skip to content
Docs

Finish or skip the onboarding

PUT
/api/workspaces/{ws}/assistant/onboarding

Whatever was set up so far stays. conversationId is the onboarding conversation, kept for later.

Authorization

session
cookiebetter-auth.session_token<token>

Set by POST /api/auth/sign-in/email.

Path Parameters

ws*string

The workspace id (from GET /api/me).

Request Body

application/json
  1. body
state*string
Value in"done""skipped"
conversationId?string|null

Response Body

Saved.

application/json
Example Request
curl -X PUT 'https://app.useroster.work/api/workspaces/string/assistant/onboarding' \  -H 'Content-Type: application/json' \  -d '{  "state": "done"}'
Example Response
{  "onboarding": "skipped"}

The assistant at a glance GET

What the assistant is called on this Roster (`name`, "Front Desk" unless renamed), where you are with the first-run onboarding (`needed` while the workspace has no hires and you haven't finished or skipped it; `done`, `skipped` or `not_needed`), the onboarding conversation to carry on, your recent conversations, suggested prompts, and whether the assistant can answer on this Roster.

Start a conversation POST

With `onboarding: true`, it starts with the onboarding's greeting and quick replies.