Skip to main content
PATCH
Update a widget key

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.

Path Parameters

widget_key_id
string<uuid>
required

The widget key id.

Body

application/json
label
string | null

null removes the label.

Required string length: 1 - 120
allowed_origins
string<uri>[]

Replaces the list.

Maximum array length: 50
Maximum string length: 2000
config
object

Replaces the whole configuration.

status
enum<string>

A revoked key can't be turned back on.

Available options:
active,
disabled,
revoked

Response

OK

data
object
required

A key that puts the chat widget on the business's websites.