Archive a Voice AI API tool

Served by the separate Voice API. Requires verified workspace owner/admin membership and VOICE_AI_API_TOOLS enabled. Credentials never appear in responses.

DELETE

https://api.channelautomation.com/api/workspaces/{workspaceId}/voice-ai/tools/{toolId}

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

workspaceId
string
required
toolId
string
required
format: uuid

Request body JSON required

version
optional
integer
Required current saved version for update, archive and test.

Returns

200

Successful operation

400

Invalid request

401

Missing or invalid access token

403

Workspace admin required or feature disabled

404

Tool not found

409

Version, name or execution conflict

413

Request too large

429

Test rate limit exceeded

503

Storage or credential service unavailable

Archive a Voice AI API tool

curl --request DELETE \
  --url 'https://api.channelautomation.com/api/workspaces/<workspaceId>/voice-ai/tools/<toolId>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "version": 0
}'

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

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/tools/<toolId>"

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

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

print(response.text)