Skip to main content
PATCH
Update a rule

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, 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.

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.

Path Parameters

rule_id
string<uuid>
required

The rule id.

Body

application/json
title
string
Required string length: 1 - 160
content
string

Up to 4,000 characters, or 8,000 for a rule with a channel, all of which calls use.

Required string length: 1 - 8000
active
boolean

false stops the receptionist following it without deleting it.

channel
enum<string> | null

null puts it back on every channel.

Available options:
voice,
sms,
web_chat,
instagram

Response

OK

data
object
required

An instruction the receptionist follows, on every channel or on one.