Skip to main content
DELETE
/
api
/
agents
/
{agent_id}
Delete Agent
curl --request DELETE \
  --url https://api.example.com/api/agents/{agent_id} \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-Organization-Id: <x-organization-id>'
{
  "success": true,
  "message": "Agent deleted successfully"
}
Delete an agent. Agents with assigned phone numbers must be unassigned first.

Headers

X-API-Key
string
required
Your API key for authentication.
X-Organization-Id
string
required
The organization ID.

Path Parameters

agent_id
string
required
The unique identifier of the agent to delete.

Permissions

  • agents:delete (admin, agent_manager)

Response

success
boolean
Indicates if the deletion was successful.
message
string
Human-readable success message.
{
  "success": true,
  "message": "Agent deleted successfully"
}