Update shared AI caller number policy

Workspace-scoped AI caller pool operation. Does not dial or change provider routing.

PATCH

https://api.channelautomation.com/api/voice-campaigns/pool-numbers/{numberId}

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

numberId
string
required
format: uuid

Request body JSON

daily_cap
optional
integer
maximum: 100000 · minimum: 1
min_spacing_seconds
optional
integer
maximum: 86400 · minimum: 0
performance_min_samples
optional
integer
maximum: 10000 · minimum: 20
decline_percent
optional
integer
maximum: 90 · minimum: 10
cooldown_hours
optional
integer
maximum: 168 · minimum: 1
state
optional
active
or
parked
or
quarantined
reason
optional
string
Required whenever state is supplied.

maxLength: 300 · minLength: 1

Returns

200

Operation succeeded

400

Invalid configuration

401

403

Workspace access or manager permission required

404

Pool or number not found

500

Unexpected server error

503

Inventory or database unavailable

Update shared AI caller number policy

curl --request PATCH \
  --url 'https://api.channelautomation.com/api/voice-campaigns/pool-numbers/<numberId>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "daily_cap": 1,
  "min_spacing_seconds": 86400,
  "performance_min_samples": 20,
  "decline_percent": 10,
  "cooldown_hours": 1,
  "state": "active",
  "reason": "string"
}
'

const url = 'https://api.channelautomation.com/api/voice-campaigns/pool-numbers/<numberId>';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    daily_cap: 1,
    min_spacing_seconds: 86400,
    performance_min_samples: 20,
    decline_percent: 10,
    cooldown_hours: 1,
    state: 'active',
    reason: 'string'
  })
};

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/voice-campaigns/pool-numbers/<numberId>"

payload = {
    "daily_cap": 1,
    "min_spacing_seconds": 86400,
    "performance_min_samples": 20,
    "decline_percent": 10,
    "cooldown_hours": 1,
    "state": "active",
    "reason": "string"
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

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

print(response.text)