Skip to main content
POST
Finish onboarding

Authorizations

Authorization
string
header
required

An API key from Settings > API keys (lsk_...), which acts on its own business, or a platform key from the PLATFORM_API_KEYS setting (lsp_...), which onboards and manages businesses. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:read, knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage, team:manage, businesses:create, users:create. Only platform keys can hold businesses:create and users:create.

Headers

LobbyStack-Business
string<uuid>

The business a platform key acts on. Required with a platform key. A per-business key may leave it out; if it sends one, it must be the key's own business.

Body

application/json
source
string

How the business heard about LobbyStack.

Maximum string length: 120
referral_code
string

An affiliate's referral code. Not accepted from a platform key, or for a business a partner onboarded.

Required string length: 1 - 64
skip_number
boolean

true finishes a paid plan's onboarding without a phone number.

Response

OK

data
object
required

How far the business is in setting up its receptionist.