Update an agent
Header Parameters
Path Parameters
Body Parameters
Show child attributes
Model to use for the agent
gemini-3.5-flashgemini-3-flash-previewgemini-3.1-flash-litegpt-realtime-2.1gpt-realtime-2.1-minigpt-4o-mini-realtime-previewgpt-4o-realtime-previewVoice to use for the agent
Words or short phrases passed to LiveKit as speech-to-text keyterms
Show child attributes
Voice pace from slow to fast. 0.5 is normal/provider default. Not all voice providers support speed control.
Whether the agent has access to knowledge
Knowledge access mode for the agent
NONEALLTAGS_ONLYTags that the agent has access to (only used when knowledgeAccessMode is TAGS_ONLY)
Show child attributes
Include the user's profile info (owner name, phone, address, DOB, company) in the agent prompt.
Include business Q&A presets (hours, pricing, services) from /business-profile in the agent prompt
Use per-agent receptionist profile fields in prompts instead of only the account profile
Prompt-facing represented person, practice, or business name
Prompt-facing represented company or business name
Prompt-facing represented company website
Prompt-facing represented company description
Prompt-facing represented company industry
Prompt-facing represented business street address
Prompt-facing represented business city
Prompt-facing represented business state
Prompt-facing represented business ZIP/postal code
Prompt-facing represented business timezone as an IANA timezone name
Whether the agent allows call transfer
Number to transfer the call to
Work hours for call transfer in HHMM format (e.g., {"MONDAY": [900, 1730]}). If null, transfer is always allowed.
Show child attributes
First message to send from the agent
Whether recipients can interrupt the initial greeting on outbound calls
Whether the generated voice prompt includes provider-specific expression guidance
Closing phrase the agent says before ending an inbound call
Seconds to wait before the voice agent joins an inbound call.
Voice recognition mode: EN for English-only (highest accuracy), MULTI for multilingual support
ENMULTIWhether the agent allows follow-ups
Custom instructions for smart follow-up messages. When provided, the AI uses these to guide follow-up content.
Whether the agent allows gathering information on incoming call
Max duration of incoming call in minutes
Max duration of outgoing call in minutes
Instructions for the agent on incoming calls
Welcoming voice mail message for contacts
Welcoming voice mail message for others
Is agent a voice mail agent
Flow structure for outgoing calls
Show child attributes
Flow structure for incoming calls
Show child attributes
Whether the agent has a typing sound for incoming calls
Whether the agent has a background sound for incoming calls
Whether the agent has a typing sound for outgoing calls
Whether the agent has a background sound for outgoing calls
Whether the agent allows incoming SMS messages
Instructions for the agent on incoming SMS messages
Whether the agent automatically responds to SMS messages
Delay in seconds before responding to SMS messages
Use incoming call flow for SMS conversations (creativity slider)
Post-call SMS message to send after incoming calls complete
Whether the agent can send SMS messages during calls via the send_sms tool
Whether the agent requires data consent before starting calls
Custom text/instructions for what consent is being requested for
Whether to enable post-call outbound actions (scheduling calls after incoming calls)
Free-form instructions for post-call actions. Example: "If HVAC emergency, call John at +1234567890 immediately. If plumbing issue, call Mike at +1555555555 in 5 minutes."
Behavior preset for normal agent create/update. New agents are currently created as employee; lead-qualify is manual/admin-only.
defaultemployeeStrictly reject incoming calls detected as spam before connecting to the agent
Custom rule for detecting valuable incoming calls after each call. Max 300 characters.
UUID of a verified caller ID to use for outbound calls. Null to clear.
Response
The agent has been successfully updated.
Response Attributes
Agent name
Agent description
Agent avatar
Is agent public
Is agent active
Agent instructions
Agent instructions for incoming calls
Max duration of incoming call in minutes
Max duration of outgoing call in minutes
Whether the agent allows gathering information on incoming call
Agent created at
Agent updated at
Agent deleted at
Creator user id
Agent tools
Show child attributes
Is agent allowed to access knowledge
Knowledge access mode for the agent
NONEALLTAGS_ONLYTags that the agent has access to when knowledge access is tag-limited
Show child attributes
Is agent allowed to schedule follow-ups
Custom instructions for smart follow-up messages
Whether the user's profile info (owner name, phone, address, DOB, company) is included in the agent prompt
Whether business Q&A presets are shared with this agent in prompts
Whether prompts should use this agent-specific represented receptionist profile
Prompt-facing represented person, practice, or business name
Prompt-facing represented company or business name
Prompt-facing represented company website
Prompt-facing represented company description
Prompt-facing represented company industry
Prompt-facing represented business street address
Prompt-facing represented business city
Prompt-facing represented business state
Prompt-facing represented business ZIP/postal code
Prompt-facing represented business timezone as an IANA timezone name
Agent voice
Agent model name
Is agent allowed to transfer calls
Phone number to transfer the call to
Work hours for call transfer in HHMM format (e.g., {"MONDAY": [900, 1730]}). If null, transfer is always allowed.
Show child attributes
First message to be sent to the agent
Whether recipients can interrupt the initial greeting on outbound calls
Whether the generated voice prompt includes provider-specific expression guidance
Closing phrase the agent says before ending an inbound call
Seconds to wait before the voice agent joins an inbound call.
Voice recognition mode: EN for English-only (highest accuracy), MULTI for multilingual support
Temperature for the agent
Data collections for the agent
Show child attributes
Evaluations for the agent
Show child attributes
Welcoming voice mail message for contacts
Welcoming voice mail message for others
Is agent a voice mail agent
Flow structure for outgoing calls
Show child attributes
Flow structure for incoming calls
Show child attributes
Voice pace from slow to fast. 0.5 is normal/provider default. Not all voice providers support speed control.
Typing sound for the agent
Background sound for the agent
Background sound for the agent
Typing sound for the agent
Whether the agent allows incoming SMS messages
Instructions for the agent on incoming SMS messages
Whether the agent automatically responds to SMS messages
Delay in seconds before responding to SMS messages
Use incoming call flow for SMS conversations (creativity slider)
Post-call SMS message to send after incoming calls complete
Whether the agent can send SMS messages during calls via the send_sms tool
Phone numbers for the agent
Show child attributes
Active email receptionist address for the agent, if any
Show child attributes
Whether the agent requires data consent before starting calls
Custom text/instructions for what consent is being requested for
Whether to enable post-call outbound actions (scheduling calls after incoming calls)
Free-form instructions for post-call actions. Example: "If HVAC emergency, call John at +1234567890 immediately."
Behavior preset for prompt generation. Supported presets are default, employee, and lead-qualify.
defaultemployeelead-qualifyStrictly reject incoming calls detected as spam before connecting to the agent
Custom rule for detecting valuable incoming calls after each call.
UUID of a verified caller ID to use for outbound calls. Null to clear.
Invalid agent instructions
Response Attributes
The message to be displayed to the user
The reason for the validation failure
Agent not found.
Response