Vobiz Logo|API Docs
Console ↗

Release a Phone Number

Releases a phone number from your account back to inventory. This operation cannot be undone.

API Endpoint
DELETEhttps://api.vobiz.ai/api/v1/account/{auth_id}/numbers/{e164_number}

Authentication Required:

  • • X-Auth-ID: Your Auth ID (e.g., {Auth_ID})
  • • X-Auth-Token: Your account Auth Token
  • • Content-Type: application/json

Warning

Releasing a phone number is a permanent action that cannot be reversed. Once released, the number returns to inventory and you will lose access to it immediately. Any active calls or configurations using this number will be affected.

Path Parameters

e164_number: The phone number in E.164 format to release (e.g., "+918071387149"). This must be a number currently assigned to your account.

No request body is required for this endpoint.

cURL - X-Auth-ID & X-Auth-Token

cURL Request
curl -X DELETE "https://api.vobiz.ai/api/v1/account/{AUTH_ID}/numbers/{PHONE_NUMBER}" \
  -H "X-Auth-ID: {AUTH_ID}" \
  -H "X-Auth-Token: {AUTH_TOKEN}"

Response Example

Success Response (200 OK)
{
  "message": "number returned to inventory"
}

Success: The phone number has been released from your account and returned to inventory.

Changes Made:

  • auth_id set to NULL
  • trunk_group_id set to NULL
  • released_at timestamp set
  • Number becomes available in inventory for purchase

Error Response (403 Forbidden): If account does not own this number:

Error Response - 403 Forbidden
{
  "error": "forbidden",
  "message": "account does not own this number"
}
Purchase from Inventory
Incoming Carrier