POST

Remove Number from Agent

Unassigns a phone number from its Agent.

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

Tears down the number's call and message routing and clears its Agent assignment. The number remains owned by the sub-account and can be reassigned later.

Headers

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

Path Parameters

phone_number_idstringrequired
The phone number to unassign.
example: pn_55ad12

Request

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

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

from vantax import Vantax

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

Response

{
  "success": true,
  "message": "Agent unassigned successfully",
  "data": {
    "id": "pn_55ad12",
    "number": "+14155550142",
    "country": "US",
    "source": "platform",
    "agent_id": null,
    "sub_account_id": "sub_8a1f4c2e",
    "capabilities": {
      "voice": true,
      "sms": true
    },
    "created_at": "2026-01-14T10:30:00Z"
  }
}

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