Update an agent

Use this endpoint to update an agent's name, phone number, or other parameters.

Path parameters

model_idstringRequired

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

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Request

This endpoint expects an object.
namestringOptional
New name for the agent.
phone_numberstringOptional
New phone number. You can retrieve a list of your phone numbers with the 'Get Numbers' API endpoint.
external_webhook_urlstringOptional

URL of the webhook that should receive data after the call. (Transcript etc.)

is_recordingbooleanOptional
is_transcript_disabledbooleanOptionalDefaults to false
Disable transcription of conversations. Transcripts will not be generated or stored.
agentobjectOptional
max_durationobjectOptional
caller_id_numberstringOptional
The number of the caller ID.
consent_recordingbooleanOptional
If enabled, the agent will ask for consent to record the call.
consent_textstringOptional
The message the agent will say to ask for consent for recording.

Response

200
statusstring or null
Whether the request was successful.
responseobject or null
detailsobject or null

Errors