Skip to main content
PATCH
Change how the chat looks

Authorizations

Authorization
string
header
required

A secret key (dk_live_…). Scopes: conversations:read, contacts:read, contacts:write, meetings:read, analytics:read, events:read, webhooks:write, knowledge:read, knowledge:write, agent:read, agent:write, experiments:read, experiments:write, privacy:write, chat:write.

Headers

Idempotency-Key
string

Retry safely: the first response is replayed for 24 hours (not for streamed answers).

Maximum string length: 255

Body

application/json
brand
string
Pattern: ^#[0-9a-fA-F]{6}$
background
string
Pattern: ^#[0-9a-fA-F]{6}$
text
string
Pattern: ^#[0-9a-fA-F]{6}$
accent
string
Pattern: ^#[0-9a-fA-F]{6}$
corners
enum<string>
Available options:
boxed,
rounded,
circle
text_size
enum<string>
Available options:
standard,
large
launcher_icon
enum<string>
Available options:
chat,
avatar
sound
boolean
motion
boolean
theme
object
revision
integer
Required range: 0 <= x <= 9007199254740991

Response

OK

object
string
required
Allowed value: "appearance"
revision
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
brand
string
required
background
string
required
text
string
required
accent
string
required
theme
object
required