DELETE

Delete Number Pool

Permanently deletes a number pool.

DELETEhttps://api.vantaxai.com/v1/number-pools/{pool_id}

Irreversible

Deleting a pool removes all of its memberships. The underlying phone numbers are not deleted and remain in your sub-account.

Headers

Authorizationstringrequired
Bearer authentication with your secret API key.
example: Bearer vx_live_3fa9c2…

Path Parameters

pool_idstringrequired
The pool to delete.
example: pool_4c8e21

Request

curl -X DELETE https://api.vantaxai.com/v1/number-pools/pool_4c8e21 \
  -H "Authorization: Bearer vx_live_3fa9c2..."

const res = await fetch(
  "https://api.vantaxai.com/v1/number-pools/pool_4c8e21",
  {
  method: "DELETE",
  headers: {
    Authorization: "Bearer vx_live_3fa9c2...",
  },
  }
);
const { data } = await res.json();

import { Vantax } from "@vantax/sdk";

const vantax = new Vantax({ apiKey: process.env.VANTAX_API_KEY! });
// DELETE /v1/number-pools/{pool_id}
const result = await vantax.request("DELETE", "/v1/number-pools/{pool_id}");

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
# DELETE /v1/number-pools/{pool_id}
result = vantax.request("DELETE", "/v1/number-pools/{pool_id}")

Response

{
  "success": true,
  "message": "Number pool deleted successfully"
}

{ "success": false, "message": "Pool not found" }