Skip to main content
PUT
Update agent
This is a full replacement operation (PUT). All fields in the request body replace the existing configuration.

​
Best Practice for Partial Updates

  1. GET the current agent configuration
  2. Modify only the fields you want to change
  3. PUT the complete updated configuration back

​
Important Notes

  • Omitted fields will be set to their default values or null
  • Active calls continue with the old configuration until completion
  • Changes take effect immediately for new calls

Path Parameters

​
agentId
string
required

Agent identifier

Body

Agent configuration

Request to create or update an agent with full configuration including name, description, behavior settings, call schedule, and inbound routing. Contains all agent properties such as enabled status, display name, optional description, complete agent configuration (TTS, LLM, STT, outbound SIP for making calls, webhooks, features, MCP connections, tools), default prompt variables in AdditionalData, time-based schedule for when outbound calls can be made, and inbound call routing configuration.

​
name
string
required

Display name for the agent. Used to identify the agent in the UI, logs, and API responses.

Required string length: 1 - 100
​
config
object
required

Complete configuration for the agent's behavior including voice settings (TTS), language model (LLM), speech recognition (STT), outbound SIP configuration for making calls, webhooks for event notifications, features like RAG and transfers, MCP connections for external services, and custom tools. This defines how the agent will interact during conversations and what capabilities it has.

​
isEnabled
boolean | null
default:true

Whether the agent is enabled and can handle calls. When disabled, the agent cannot make outbound calls or handle inbound routing.

​
description
string | null

Optional description explaining the agent's purpose, behavior, or use case. Useful for documentation and team collaboration to understand what this agent is designed to do.

​
additionalData
object | null

Default data for variable interpolation in agent prompts. Values can be referenced in prompts using {{variableName}} syntax. These serve as default values for the agent and can be overridden on a per-call basis when enqueueing calls.

​
schedule
object | null

Time-based schedule defining when the agent can make outbound calls. Specifies available time slots for each day of the week and the timezone for schedule interpretation. Scheduled calls will only be placed during these time windows.

​
inboundSipConfig
object | null

Configuration for routing inbound calls to this agent. To configure phone number routing for incoming calls, use the SIP phone numbers API to assign a phone number to this agent instead of using this field directly.

​
expectedVersion
integer<int32> | null

Expected version number for optimistic concurrency control. If provided and does not match the current server version, the update will be rejected with a 409 Conflict response containing the current server state. Omit to skip version checking (not recommended for UI clients).

Response

Agent updated successfully

Complete agent details including all configuration, identifiers, timestamps, schedule, and inbound routing. Contains the full agent state including enabled status, display name, optional description, complete agent configuration (TTS, LLM, STT, outbound SIP for making calls, webhooks, features, MCP connections, tools), default prompt variables in AdditionalData, unique identifiers, creation and update timestamps, call schedule for outbound calls, and inbound call routing configuration.

​
name
string
required

Display name for the agent. Used to identify the agent in the UI, logs, and API responses.

Required string length: 1 - 100
​
config
object
required

Complete configuration for the agent's behavior including voice settings (TTS), language model (LLM), speech recognition (STT), outbound SIP configuration for making calls, webhooks for event notifications, features like RAG and transfers, MCP connections for external services, and custom tools. This defines how the agent will interact during conversations and what capabilities it has.

​
agentId
string
required

Unique identifier for the agent. Use this ID to reference the agent in API calls, call enqueueing, and WebSocket connections.

Minimum string length: 1
​
orgId
string
required

Organization identifier that owns this agent. All resources and calls for this agent are scoped to this organization.

Minimum string length: 1
​
createdTime
string<date-time>
required

Timestamp when the agent was created. Recorded in UTC.

​
lastUpdateTime
string<date-time>
required

Timestamp when the agent was last updated. Recorded in UTC and updated whenever any agent configuration changes.

​
version
integer<int32>
required

Optimistic concurrency version number. Increases with each update. Use this value as expectedVersion when updating to detect concurrent modifications.

​
inboundSipConfig
object
required

Inbound call routing configuration showing which phone number routes incoming calls to this agent. Includes the unique configuration ID, assigned phone number, SIP URI for routing, and trunk URI. To modify phone number routing, use the SIP phone numbers API.

​
schedule
object
required

Time-based schedule defining when the agent can make outbound calls. Specifies available time slots for each day of the week and the timezone for schedule interpretation. Scheduled calls will only be placed during these time windows.

​
isEnabled
boolean | null
default:true

Whether the agent is enabled and can handle calls. When disabled, the agent cannot make outbound calls or handle inbound routing.

​
description
string | null

Optional description explaining the agent's purpose, behavior, or use case. Useful for documentation and team collaboration to understand what this agent is designed to do.

​
additionalData
object | null

Default data for variable interpolation in agent prompts. Values can be referenced in prompts using {{variableName}} syntax. These serve as default values for the agent and can be overridden on a per-call basis when enqueueing calls.