Skip to main content
PATCH
Change the agent's settings, or switch the chat on or off

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
name
string
Required string length: 1 - 100
tone
enum<string>
Available options:
friendly,
professional,
direct
greeting
string
Required string length: 1 - 200
intro
string
Maximum string length: 300
suggestions
string[]
Maximum array length: 6
Required string length: 1 - 120
Maximum string length: 1500
business_context
string
Required string length: 40 - 20000
allowed_origins
string[]
Maximum array length: 50
Required string length: 1 - 300
opening
object
automation
object
live
boolean

Response

OK

object
string
required
Allowed value: "agent"
name
string
required
role
string
required
tone
string
required
greeting
string
required
intro
string
required
suggestions
string[]
required
business_context
string
required
allowed_origins
string[]
required
opening
object
required
automation
object
required
live
boolean
required
site_key
string
required
embed_snippet
string
required