DELETE

Release Phone Number

Releases a phone number back to the carrier.

DELETEhttps://api.vantaxai.com/v1/phone-numbers/{phone_number_id}

Releasing a number stops its monthly rental charge and unassigns it from any Agent. If the number was assigned, its inbound call and message routing is torn down first.

Irreversible

Releasing a number returns it to the carrier and cannot be undone. You may not be able to reclaim the same number afterwards. Any Agent currently using it will stop receiving calls and messages on this number.

Headers

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

Path Parameters

phone_number_idstringrequired
The phone number to release.
example: pn_55ad12

Request

curl -X DELETE https://api.vantaxai.com/v1/phone-numbers/pn_55ad12 \
  -H "Authorization: Bearer vx_live_3fa9c2..."

const res = await fetch(
  "https://api.vantaxai.com/v1/phone-numbers/pn_55ad12",
  {
  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/phone-numbers/{phone_number_id}
const result = await vantax.request("DELETE", "/v1/phone-numbers/{phone_number_id}");

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
# DELETE /v1/phone-numbers/{phone_number_id}
result = vantax.request("DELETE", "/v1/phone-numbers/{phone_number_id}")

Response

{
  "success": true,
  "message": "Phone number released successfully"
}

{
  "success": false,
  "message": "Phone number not found"
}