Update an agent
update_agentModify an existing voice agent by sending only the fields to change; omitted settings remain untouched. Send a new voice object to replace the entire voice configuration.
Instructions
Change an agent. Only the fields you send are changed; omit the rest. Sending voice replaces the whole voice object.
Requires scope agents:write.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The record id, e.g. "6a96a3ead6e886d42462dd3e". | |
| name | No | A label for your own reference, e.g. "Support line". | |
| voice | No | Either a COMPOSED pipeline {stt, llm, tts} (all three required together) or a single REALTIME model {realtime}. Never both. Use list_engines to pick models that are available right now. | |
| language | No | BCP-47 tag for the conversation, e.g. "en-US" or "hi-IN". | |
| system_prompt | No | The agent's instructions. This is a spoken conversation, so keep it short, concrete, and free of markdown. | |
| opening_message | No | Spoken as soon as the call connects. Supports {{name}} style merge fields from the lead. Required: an agent without one answers in silence. | |
| knowledge_base_id | No | A knowledge base the agent can draw on. See list_knowledge_bases. | |
| outbound_phone_number_id | No | Default caller id for outbound calls placed with this agent. See list_phone_numbers. | |
| appointment_booking_enabled | No | Let the agent book appointments during a call. |