Archive an unused nondefault agent and retain history

Requires workspace owner, admin or manager. No page-load initialization. Creation requires capability version 1 from voice_service, ingest_worker and trigger.

POST

https://api.channelautomation.com/api/workspaces/{workspaceId}/voice-ai/agents/{agentId}/archive

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

workspaceId
string
required
agentId
string
required
format: uuid

Request body JSON required

Returns

200

Successful response with masked settings

JSON

success
optional
boolean
agent
optional
object
Profile metadata and name without voice_config or credentials
legacy
optional
boolean
True until profiles have been explicitly created
uses_builtin
optional
boolean
True when an OpenAI voice_ai block or profiles exist; controls the built-in fleet and tour
agents
optional
array of
object
Without profiles the latest legacy voice row is returned. A built-in config without a pointer returns a legacy entry with null agent_id that opens workspace settings without initialization.
config
optional
object
Normalized settings with credential configured booleans

400

Invalid request or unavailable agent

401

Authentication required

403

Workspace admin or manager required

404

Agent not found

409

Default or in-use agent; refusal names published flows or explains assigned phone numbers. Republish referencing flows and clear assignments before retrying

500

Service error

503

Migration or consumer capabilities unavailable

Archive an unused nondefault agent and retain history

curl --request POST \
  --url 'https://api.channelautomation.com/api/workspaces/<workspaceId>/voice-ai/agents/<agentId>/archive' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

const url = 'https://api.channelautomation.com/api/workspaces/<workspaceId>/voice-ai/agents/<agentId>/archive';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/workspaces/<workspaceId>/voice-ai/agents/<agentId>/archive"

payload = {}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "success": true,
  "agent": {},
  "legacy": true,
  "uses_builtin": true,
  "agents": [
    {}
  ],
  "config": {}
}