Skip to main content
PATCH
Update Agent

Authorizations

Authorization
string
header
required

Company API Key

Path Parameters

agent_id
string
required

The ID of the agent to update

Body

application/json

Agent fields to update

name
string

Agent name

timezone
string

Timezone name (e.g. "America/New_York")

first_message
string

First message shown in supported chat surfaces

webhook_url
string

Webhook URL (if applicable)

webhook_headers
object

Replace the agent's webhook header set. Each value may be a plain string (non-secret) or {value, secret}. For a secret header that already exists, submitting an empty value preserves the stored value — to clear a header, omit it from the dict.

branding_colour
string

"" or hex #RGB / #RRGGBB

interrupt_mode
enum<string>

Chat agent interrupt mode toggle

Available options:
true,
false
prompt
string

Full prompt replacement

line_edits
object[]

Incremental prompt edits applied server-side

Response

Agent updated successfully