Saltar al contenido principal
PATCH
Update the receptionist settings

Autorizaciones

Authorization
string
header
requerido

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.

Encabezados

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.

Cuerpo

application/json
greeting
string
Required string length: 1 - 2000
tone
string
Required string length: 1 - 2000
summary
string

AI never rewrites a summary set here.

Required string length: 1 - 2000
regenerate_summary
boolean

Hands the summary back to AI, which rewrites it from the business's knowledge. Can't be sent with summary.

booking_policy
string
Required string length: 1 - 2000
voice_instructions
string | null

null removes them.

Required string length: 1 - 8000
sms_instructions
string | null

null removes them.

Required string length: 1 - 8000
chat_instructions
string | null

null removes them.

Required string length: 1 - 8000
transfer_mode
enum<string>
Opciones disponibles:
never,
always,
on_request,
on_urgent,
during_business_hours
transfer_number
string | null

null removes it, which stops transfers.

Pattern: ^\+[1-9]\d{6,14}$
booking_mode
enum<string>
Opciones disponibles:
off,
request,
instant
appointment_change_policy
object

Send all four fields.

Respuesta

OK

data
object
requerido

How the receptionist answers, what it says about the business, and what it may do.