PUT /aiagents/{agent_id}
Update the selected AI Agent details. Only the submitted fields are changed, every other field keeps its current value.
agent_name, voice, business_description and instructions cannot be cleared: submitting any of them empty fails the request. An omitted field keeps its current value, and the request also fails if one of these required values is already missing from the stored agent.
When the resulting agent_role is other, custom_agent_role must remain populated. Likewise, custom_business_type must remain populated when the resulting business_type is other. This applies whether the controlling field is submitted or retained from the existing agent.
Submitted agent_role, business_type and greeting values must be keys reported by List Agent Options. The resulting voice is always checked against the reported voice keys, including when voice is omitted from the request. contact_email, when populated, must be a valid email address, and instructions cannot exceed 4000 characters. Other details can be cleared by submitting null, subject to the conditional custom-field requirements above.
The instructions are not re-generated when the agent details change, see the Instructions section above.
Advanced settings are not part of this request, they are changed with the Update AI Agent Advanced Settings request.
Examples Update the agent greeting
{
"greeting" : "warm"
}Update the agent instructions
{
"instructions" : "You are the Example Realty phone assistant. Answer politely and collect the caller details."
}