Agents
Update User Agent
Update the properties of an existing AI agent by its ID.
PUT
Headers
string
required
Your API key for authentication. Prefix with
Bearer .Path Parameters
string
required
The unique identifier of the agent you want to update.
Body
This endpoint acceptsmultipart/form-data. Send only the fields you wish to update.
string
The new name for the agent.
string
The ID of a new voice model for the agent.
string
Update the primary language for the agent’s conversation.
string
Update the prompt or script defining the agent’s conversational flow.
string
Update the agent to use a different pre-configured template.
string
Change the initial message the agent uses to start a conversation.
string
Update the prompt defining how the agent should qualify leads.
string
Update the description of the objectives or goals for the agent.
string
Modify the background information or context for the agent.
string
Provide a new example conversation or scenario to guide the agent.
file
Upload a new avatar image file for the agent.
string
Update the instructions on what the agent should avoid.
Response
On success, the response will contain the complete, updated agent object.string
Confirms the request was successful.
string
A human-readable message, e.g., “Agent updated successfully”.
object
An object containing the full, updated details of the agent.