Skip to main content
PUT
Update an existing agent.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

agentId
string
required

Body

application/json

Fields to update

Request body for updating an agent (include only fields to update)

agentPrompt
string

Agent-specific prompt

aiContactCaptureEnabled
boolean

Whether AI passively extracts contact info from conversations

avatarImage
string

URL or base64 avatar image

channelSettings
object

Multi-channel configuration: {website?: {enabled: boolean}, email?: {enabled: boolean, address?: string}, sms?: {enabled: boolean, phoneNumber?: string}, voice?: {enabled: boolean}}

contactListId
string

Smart list ID for contact collection

customColors
object

Branding colors: {primary?: string (hex), secondary?: string (hex), background?: string (hex)}

isActive
boolean

Whether agent is active

knowledgeBaseEnabled
boolean

Whether the agent answers from the knowledge base

knowledgeBaseScope
string

Knowledge base folder the agent is limited to (e.g. / or /shared/Support)

leadFields
object[]

Lead field definitions: [{name: string, type: string (text, email, phone, number), required?: boolean}]

model
string

AI model (e.g., gpt-4o-mini)

multiStepMaxTurns
integer

Tool-calling turns allowed before tools are removed and the agent must answer (1-10, default 5)

multiStepToolsEnabled
boolean

Whether the agent can chain multiple tool-calling turns (knowledge base search, MCP servers, integration toolsets) instead of a single round

name
string

Agent name

systemPrompt
string

AI system instructions

Response

The updated agent

Agent object

agentPrompt
string

Agent-specific prompt

aiContactCaptureEnabled
boolean

Whether AI passively extracts contact info from conversations

avatarImage
string

URL or base64 avatar image

channelSettings
object

Multi-channel configuration

contactListId
string

Smart list ID

created
number

Creation timestamp

customColors
object

Branding colors configuration

id
string

Agent ID

isActive
boolean

Whether agent is active

knowledgeBaseEnabled
boolean

Whether the agent answers from the knowledge base

knowledgeBaseScope
string

Knowledge base folder the agent is limited to (e.g. / or /shared/Support)

leadFields
object[]

Lead field definitions

model
string

AI model

multiStepMaxTurns
integer

Tool-calling turns allowed before tools are removed and the agent must answer (1-10, default 5)

multiStepToolsEnabled
boolean

Whether the agent can chain multiple tool-calling turns (knowledge base search, MCP servers, integration toolsets) instead of a single round

name
string

Agent name

shortCode
string

Shareable URL code

systemPrompt
string

AI system instructions

updated
number

Last update timestamp