Platform APIAgents

Update an agent

View as Markdown
Use this endpoint to update an agent's name, phone number, or other parameters. Only the provided parameters will be updated, and others won't be removed or changed.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

model_idstringRequired

Agent ID. You can find it on the agent’s page in your dashboard.

Request

This endpoint expects an object.
agentobjectOptional
descriptionstringOptional
Agent description.
end_call_reasons_v2list of objectsOptional

Custom conditions that trigger automatic call termination with per-reason closing message control. When both end_call_reasons and end_call_reasons_v2 are present, v2 takes precedence.

external_webhook_urlstringOptional
URL of the webhook that should receive data after the call, such as the transcript.
is_recordingbooleanOptional
Whether the conversation should be recorded.
max_durationobjectOptional
namestringOptional
Agent name.
phone_numberstringOptional
The phone number attached to the agent.
voicemail_messageobjectOptional

Configuration for the message left when a voicemail is detected. Requires greeting_message_mode to be set to human.

end_call_reasonslist of stringsOptionalDeprecated

Deprecated: use end_call_reasons_v2 instead. Custom conditions that trigger automatic call termination (simple string array format).

Response

200
statusstring
Whether the request was successful.
responseobject
detailsobject

Errors

400
Bad Request Error