Update a caller pool number

PUT

api

account

{account_id}

campaigns

{campaign_id}

pool

{number_id}

Update a caller pool number

curl --request PUT \
  --url https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/pool/{number_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <x-auth-id>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "label": "<string>",
  "is_active": true
}
'

import requests

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

payload = {
    "label": "<string>",
    "is_active": True
}
headers = {
    "X-Auth-ID": "<x-auth-id>",
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'X-Auth-ID': '<x-auth-id>',
    'X-Auth-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({label: '<string>', is_active: true})
};

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));

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

Change a number’s label or its active state.

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.

string

Human-readable label, maximum 100 characters.

boolean

Set to false to exclude the number from future selection while keeping its history.

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 PUT \
  "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}" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Primary DID",
    "is_active": false
  }'

Disabling excludes the number from future selection without removing its call history, so its total_calls and daily_calls counters remain readable through List pool numbers.

Update a caller pool number

curl --request PUT \
  --url https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/pool/{number_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <x-auth-id>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "label": "<string>",
  "is_active": true
}
'

import requests

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

payload = {
    "label": "<string>",
    "is_active": True
}
headers = {
    "X-Auth-ID": "<x-auth-id>",
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'X-Auth-ID': '<x-auth-id>',
    'X-Auth-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({label: '<string>', is_active: true})
};

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