DELETE

Remove Phone Number from Agent

Unassigns a phone number from the Agent.

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

Headers

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

Path Parameters

agent_idstringrequired
The Agent that owns the assignment.
example: agt_3d9b21
phone_number_idstringrequired
The number to unassign.
example: pn_55ad12

Request

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

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

from vantax import Vantax

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

Response

{
  "success": true,
  "message": "Phone number removed from Agent",
  "data": { "id": "pn_55ad12", "agent_id": null }
}