Assign or clear the inbound voice agent for an owned number

Does not redirect the number or change Twilio settings. Consumer readiness is required before assigning. Clears use null and preserve default routing. Takes effect within the five-second runtime memo window.

PUT

https://api.channelautomation.com/api/workspaces/{workspaceId}/voice-ai/numbers/{phone}

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

workspaceId
string
required
phone
string
required
URL-encoded E.164 or formatted phone number

Request body JSON required

agent_id
string
or null
required
format: uuid

Returns

200

Assignment saved or cleared

400

Invalid phone or agent

401

Authentication required

403

Admin or manager role required

409

Agent disabled or not set up

503

Migration or consumers not ready; assignment unchanged

Assign or clear the inbound voice agent for an owned number

curl --request PUT \
  --url 'https://api.channelautomation.com/api/workspaces/<workspaceId>/voice-ai/numbers/<phone>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978"
}
'

const url = 'https://api.channelautomation.com/api/workspaces/<workspaceId>/voice-ai/numbers/<phone>';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({agent_id: '2b1e3b65-2c04-4fa2-a2d7-467901e98978'})
};

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/numbers/<phone>"

payload = { "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978" }
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

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

print(response.text)