Remove a caller pool number

DELETE

api

account

{account_id}

campaigns

{campaign_id}

pool

{number_id}

Remove a caller pool number

curl --request DELETE \
  --url https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/pool/{number_id} \
  --header 'X-Auth-ID: <x-auth-id>' \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/pool/{number_id}"

headers = {
    "X-Auth-ID": "<x-auth-id>",
    "X-Auth-Token": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'DELETE',
  headers: {'X-Auth-ID': '<x-auth-id>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/pool/{number_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

DELETE https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/pool/{number_id}

Removes the number from the pool.

Authentication required

X-Auth-ID — your Vobiz account ID
X-Auth-Token — your Vobiz auth token

string

required

Your Vobiz account ID. Use the same value in X-Auth-ID.

string

required

Your Vobiz account ID, for example MA_XXXXXXXX.

string

required

The pool campaign that owns the number.

string

required

ID of the pool number, returned by Add pool numbers.

The pool can be edited only while the campaign is draft or ready. Add, update, and delete return 409 while it is running, paused, or queued.

Example

cURL

curl -X DELETE \
  "https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/pool/{number_id}" \
  -H "X-Auth-ID: {account_id}" \
  -H "X-Auth-Token: {auth_token}"

To take a number out of rotation temporarily, set is_active: false with Update a pool number instead. That keeps the number and its usage counters in the pool.

Remove a caller pool number

curl --request DELETE \
  --url https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/pool/{number_id} \
  --header 'X-Auth-ID: <x-auth-id>' \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/pool/{number_id}"

headers = {
    "X-Auth-ID": "<x-auth-id>",
    "X-Auth-Token": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'DELETE',
  headers: {'X-Auth-ID': '<x-auth-id>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/pool/{number_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

​Example

Example