Delete an Agent

cURL

curl --request DELETE \
  --url https://my.cald.ai/client/api/v1/agents/{agentId} \
  --header 'Authorization: <api-key>'

{
  "status": "<string>"
}

DELETE

agents

{agentId}

cURL

curl --request DELETE \
  --url https://my.cald.ai/client/api/v1/agents/{agentId} \
  --header 'Authorization: <api-key>'

{
  "status": "<string>"
}

An agent can’t be deleted if it’s being used in a campaign, error code 400 will be returned.

Authorization

string

header

required

Your API key, e.g. caldLiveDe39a3accb206dd615f30d118e519df0

agentId

string

required

The agent ID of the agent

Success response with agent details

status

string

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