Skip to main content
PATCH
/
v1
/
agent
/
{id}
Update Agent
curl --request PATCH \
  --url https://api.nedzo.ai/v1/agent/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "language": "English",
  "phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phone_number_option": "Shared US phone collection",
  "voice": "Joseph (English)",
  "background_sound": true,
  "description": "<string>",
  "first_message": "<string>",
  "ivr_navigation": true,
  "prompt": "<string>",
  "transfer_phone_number": "<string>",
  "transfer_sentence": "<string>",
  "leave_voicemail_message": true,
  "voicemail_message": "<string>",
  "webhook_url": "<string>"
}
'
{
  "status_code": 123,
  "message": "<string>",
  "data": {
    "agent": {
      "name": "<string>",
      "language": "English",
      "phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "phone_number_option": "Shared US phone collection",
      "voice": "Joseph (English)",
      "background_sound": true,
      "description": "<string>",
      "first_message": "<string>",
      "ivr_navigation": true,
      "prompt": "<string>",
      "transfer_phone_number": "<string>",
      "transfer_sentence": "<string>",
      "leave_voicemail_message": true,
      "voicemail_message": "<string>",
      "webhook_url": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "total_dials": 123,
      "total_outcomes": 123,
      "total_seconds": 123
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
name
string | null

The name of the agent.

​
language
enum<string> | null

The language the agent will speak. Agent's language selection enum

Available options:
English,
Portuguese,
German,
Spanish,
French,
Dutch,
Norwegian
​
phone_number_id
string<uuid> | null

The unique ID of the phone number assigned to this agent.

​
phone_number_option
enum<string> | null

Specifies whether to use a shared or dedicated phone number.

Available options:
Shared US phone collection,
My own phone number
​
voice
enum<string> | null

The specific voice the agent will use.

Available options:
Joseph (English),
Will (English),
Magnus (English),
Kai (English),
Graham (English),
Jacqui (English),
Paul (English),
Heracles (English),
Jamie (English),
Ollie (English),
George (English),
Carl (English),
Dakota (English),
Ava (English),
Kim (English),
Sarah (English),
Emma (English),
Hope (English),
Barbara (English),
Meera (English),
Arabella (English),
Emily (English),
Megan (English),
Aisling (English),
Connor (English),
Francisco (PT-PT),
João (PT-PT),
Jessica (PT-PT),
Ana (PT-PT),
Barbara (PT-PT),
Rita (PT-PT),
Bia (PT-PT),
Vasco (PT-PT),
Diogo (PT-BR),
Joseph (German),
Eva (German),
Susi (German),
Ben (German),
Joseph (Spanish),
Tony (Spanish),
Sara (Spanish),
Martin (Spanish),
Andrea (Spanish),
Camila (Spanish),
Leonardo (Spanish),
Miguel (Spanish),
Javier (Spanish),
Valentina (Spanish),
Joseph (French),
Antoine (French),
Louis (French),
Amélie (French),
Juliette (French),
Jean (French),
Bart (Dutch),
Joseph (Dutch),
Hope (Portuguese),
Jakob (Norwegian)
​
background_sound
boolean | null

Enable or disable background sound for the agent's calls.

​
description
string | null

A brief description of the agent's purpose or role.

​
first_message
string | null

The initial message the agent will say when a call connects.

​
ivr_navigation
boolean | null

Enable or disable IVR (Interactive Voice Response) navigation features.

​
prompt
string | null

The system prompt or instructions that define the agent's behavior and personality.

​
transfer_phone_number
string | null

The phone number to transfer calls to if requested.

​
transfer_sentence
string | null

A specific sentence or phrase that will trigger a call transfer.

​
leave_voicemail_message
boolean | null

Enable or disable the agent's ability to leave a voicemail.

​
voicemail_message
string | null

The pre-recorded message to be left as a voicemail.

​
webhook_url
string | null

A URL to which call data and events will be posted.

Response

Successful Response

​
status_code
integer
required
​
message
string
required
​
data
object | null