Update an existing agent.
Updates the agent configuration. Only include fields that need to be changed - unspecified fields will retain their current values.
Authorizations
Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.
Path Parameters
Body
Fields to update
Request body for updating an agent (include only fields to update)
Agent-specific prompt
Whether AI passively extracts contact info from conversations
URL or base64 avatar image
Multi-channel configuration: {website?: {enabled: boolean}, email?: {enabled: boolean, address?: string}, sms?: {enabled: boolean, phoneNumber?: string}, voice?: {enabled: boolean}}
Smart list ID for contact collection
Branding colors: {primary?: string (hex), secondary?: string (hex), background?: string (hex)}
Whether agent is active
Whether the agent answers from the knowledge base
Knowledge base folder the agent is limited to (e.g. / or /shared/Support)
Lead field definitions: [{name: string, type: string (text, email, phone, number), required?: boolean}]
AI model (e.g., gpt-4o-mini)
Tool-calling turns allowed before tools are removed and the agent must answer (1-10, default 5)
Whether the agent can chain multiple tool-calling turns (knowledge base search, MCP servers, integration toolsets) instead of a single round
Agent name
AI system instructions
Response
The updated agent
Agent object
Agent-specific prompt
Whether AI passively extracts contact info from conversations
URL or base64 avatar image
Multi-channel configuration
Smart list ID
Creation timestamp
Branding colors configuration
Agent ID
Whether agent is active
Whether the agent answers from the knowledge base
Knowledge base folder the agent is limited to (e.g. / or /shared/Support)
Lead field definitions
AI model
Tool-calling turns allowed before tools are removed and the agent must answer (1-10, default 5)
Whether the agent can chain multiple tool-calling turns (knowledge base search, MCP servers, integration toolsets) instead of a single round
Agent name
Shareable URL code
AI system instructions
Last update timestamp

