Skip to main content
POST
Skip or stop onboarding

Authorizations

Authorization
string
header
required

The session token of an admin of your company. Company API, partner and droplet installation tokens are refused.

Path Parameters

bot_id
string<uuid>
required

The bot's id.

run_id
string<uuid>
required

The id of one of the bot's runs.

Body

application/json
skip
enum<string>
Available options:
cadence,
preference
stop
boolean

Response

The onboarding state.

onboarding
object
required

The bot's first-day onboarding (D-424).

status
integer
required
meta
object
required

Response metadata on every body. List endpoints add pagination.