Skip to main content
POST
Invite someone

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.

Idempotency-Key
string
required

Required. A unique value, up to 255 characters, that makes retries of this request safe.

Maximum string length: 255

Body

application/json
email
string
required

One address. Only a LobbyStack account with this verified email can accept.

Required string length: 3 - 320
role
enum<string>
required
Available options:
business_admin,
scheduler,
viewer

Response

Created

data
object
required

An invitation nobody has accepted yet.