Passer au contenu principal
PATCH
Update the receptionist settings

Autorisations

Authorization
string
header
requis

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, phone_numbers:purchase, partner:read, partner.businesses:write, partner.demos:write, partner.packages:write, partner.branding:write, partner.templates:write, partner.team:write, partner.billing:read, partner.billing:write. Only platform keys can hold businesses:create and users:create, and only a key a partner made in its console can hold the partner scopes, which the Partner endpoints use. Only a partner's owners grant partner.billing:read and partner.billing:write.

En-têtes

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.

Corps

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

Deprecated: use /rules with channel voice. Sets the text of the first voice rule and turns it on, adding the rule when there's none. null deletes that rule.

Required string length: 1 - 8000
sms_instructions
string | null

Deprecated: use /rules with channel sms. Sets the text of the first sms rule and turns it on, adding the rule when there's none. null deletes that rule.

Required string length: 1 - 8000
chat_instructions
string | null

Deprecated: use /rules with channels web_chat and instagram. Sets the text of the first web_chat rule and the first instagram rule and turns them on, adding them when there are none. null deletes them.

Required string length: 1 - 8000
transfer_mode
enum<string>
Options 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>
Options disponibles:
off,
request,
instant
voice
enum<string>

Calls that start after the business snapshot refreshes use it.

Options disponibles:
alloy,
ash,
ballad,
beacon,
bossa,
cedar,
cinder,
coral,
delta,
echo,
gleam,
marin,
meridian,
quartz,
ripple,
sage,
shimmer,
stone,
tempo,
verse,
vesper,
willow
staff_first_mode
enum<string>

business_hours and always need a staff_first_number, a paid plan and a Twilio number.

Options disponibles:
never,
business_hours,
always
staff_first_number
string | null

Follows the same rules as transfer_number, and can't be one of the business's own numbers.

Pattern: ^\+[1-9]\d{6,14}$
staff_first_ring_seconds
staff_first_message
string | null

null removes it.

Required string length: 1 - 200
staff_first_handover_message
string | null

null removes it.

Required string length: 1 - 200
appointment_change_policy
object

Send all four fields.

Réponse

OK

data
object
requis

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