Archive an agent
delete (archive and deactivate) an AI agent.
DELETE
https://api.centerfy.ai/webhooks/inbound/agents/:id Headers
| Header | Required | Value | Description |
|---|---|---|---|
x-api-key | Yes | your sub-account API key (cfy_…) | Authenticates the request; or use Authorization: Bearer <key>. |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | The agent id. |
Example
curl -X DELETE "https://api.centerfy.ai/webhooks/inbound/agents/{id}" \
-H "x-api-key: $CENTERFY_API_KEY" import { CenterfyClient } from "@centerfy/sdk";
const centerfy = new CenterfyClient({ apiKey: process.env.CENTERFY_API_KEY! });
const result = await centerfy.agents.archive("<agentId>");
console.log(result); centerfy agents archive <agentId> MCP tool: centerfy_agents_archive (see MCP server)
Response
{
"status": "success",
"deleted": true,
"agent_id": "<agent_id>",
"archived_at": "2026-06-12T10:30:00.000Z"
}Notes
Not a hard delete — archives the agent and deactivates it (is_active=false) so it stops taking calls, while its phone and call history remain intact. Idempotent: re-deleting an already-archived agent succeeds again. Errors: 400 (invalid agent id), 401 (unauthenticated), 404 (agent not found), 500 (server error). Success is 200.