POST

Create Number Pool

Creates a new number pool in the specified sub-account.

POSThttps://api.vantaxai.com/v1/number-pools

Pool names must be unique within a sub-account (case-insensitive) and 80 characters or fewer. Add phone numbers to the pool afterward with Add Phone Numbers to Pool.

Headers

Authorizationstringrequired
Bearer authentication with your secret API key.
example: Bearer vx_live_3fa9c2…
Content-Typestringrequired
Must be application/json for requests with a body.
example: application/json

Body Parameters

namestringrequired
Display name of the pool. Must be unique within the sub-account.
example: Outbound Sales Pool
sub_account_idstringrequired
Sub-account that will own the pool.
example: sub_8a1f4c2e
descriptionstringoptional
Optional description of the pool's purpose.

Request

curl -X POST https://api.vantaxai.com/v1/number-pools \
  -H "Authorization: Bearer vx_live_3fa9c2..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Outbound Sales Pool",
    "sub_account_id": "sub_8a1f4c2e",
    "description": "Rotating numbers for the West Coast dialer"
  }'

const res = await fetch("https://api.vantaxai.com/v1/number-pools", {
  method: "POST",
  headers: {
    Authorization: "Bearer vx_live_3fa9c2...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Outbound Sales Pool",
    sub_account_id: "sub_8a1f4c2e",
    description: "Rotating numbers for the West Coast dialer",
  }),
});
const { data: pool } = await res.json();

const pool = await vantax.numberPools.create({
  name: "Outbound Sales Pool",
  subAccountId: "sub_8a1f4c2e",
  description: "Rotating numbers for the West Coast dialer",
});

pool = vantax.number_pools.create(
    name="Outbound Sales Pool",
    sub_account_id="sub_8a1f4c2e",
    description="Rotating numbers for the West Coast dialer",
)

Response

{
  "success": true,
  "message": "Number pool created successfully",
  "data": {
    "id": "pool_4c8e21",
    "name": "Outbound Sales Pool",
    "description": "Rotating numbers for the West Coast dialer",
    "sub_account_id": "sub_8a1f4c2e",
    "member_count": 0,
    "members": [],
    "created_at": "2026-01-14T10:30:00Z"
  }
}

{
  "success": false,
  "message": "A pool with that name already exists"
}

{
  "success": false,
  "message": "Validation failed",
  "errors": [
    { "field": "name", "message": "name is required" }
  ]
}