Park a workspace number

Current workspace membership is required. Header, query and body workspace selectors must agree. Matching header-only callers remain supported; membership roles are unchanged.

POST

https://api.channelautomation.com/api/number-rotation/numbers/{id}/park

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

id
string
required

Query parameters

workspace_id
optional
string
Must match the authorized workspace when supplied.

Header parameters

X-Workspace-Id
optional
string
Selected workspace; any supplied query/body selector must match it.

Returns

200

Existing handler response

400

Missing or invalid workspace selection

401

Missing or invalid verified session

403

Membership denied or a supplied workspace selector conflicts

503

Authentication or membership lookup unavailable

Park a workspace number

curl --request POST \
  --url 'https://api.channelautomation.com/api/number-rotation/numbers/<id>/park' \
  --header 'Authorization: Bearer <token>'

const url = 'https://api.channelautomation.com/api/number-rotation/numbers/<id>/park';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

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/number-rotation/numbers/<id>/park"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)