PATCH
/
agents
/
{agentId}
curl --request PATCH \
  --url https://my.cald.ai/client/api/v1/agents/{agentId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "maxCallDuration": 10,
  "recordingSettings": {
    "enable": false
  },
  "instructions": "<string>",
  "greeting": "<string>",
  "transferSettings": {
    "enable": false,
    "rule": "always",
    "phoneNumber": "<string>"
  },
  "machineSettings": {
    "enable": false
  },
  "voicemailSettings": {
    "enable": false,
    "voicemail": "<string>"
  },
  "webhookSettings": {
    "enable": false,
    "url": "<string>"
  },
  "smsSettings": {
    "enable": false,
    "rule": "always",
    "message": "<string>"
  },
  "voice": "standard_male"
}'
{
  "status": "<string>"
}

Authorizations

​
Authorization
string
header
required

Your API key, e.g. caldLiveDe39a3accb206dd615f30d118e519df0

Path Parameters

​
agentId
string
required

The agent ID of the agent

Body

application/json
​
name
string

The name given to the agent in the MyCald Dashboard

​
maxCallDuration
number
default:
10

The maximum duration of a call in minutes, between 1 and 60

​
recordingSettings
object
​
instructions
string

The instructions for the agent, for example, Hi, convince the prospect to buy the product

​
greeting
string

The greeting for the agent, for example, Hi there!

​
transferSettings
object
​
machineSettings
object
​
voicemailSettings
object
​
webhookSettings
object
​
smsSettings
object
​
voice
string
default:
standard_male

The voice ID of the voice to use for the agent, for example, standard_male

Response

200
application/json
Success response with agent details
​
status
string

Whether the agent was successfully updated, can be either success or failed

Get an AgentDelete an Agent