Skip to main content
DELETE
/
api
/
phone-numbers
/
{phone_number_id}
Delete Phone Number
curl --request DELETE \
  --url https://api.example.com/api/phone-numbers/{phone_number_id} \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-Organization-Id: <x-organization-id>'
{
  "success": true,
  "message": "Phone number deleted successfully",
  "data": {
    "phone_number_id": "phon_a1b2c3d4e5f6",
    "phone_number": "+15551234567",
    "provider": "twilio",
    "status": "free",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T15:00:00Z"
  }
}
Delete a phone number. For SIP providers, this also cleans up associated LiveKit trunks.
Cannot delete phone numbers that are assigned to agents. Unassign first.

Headers

X-API-Key
string
required
Your API key for authentication.
X-Organization-Id
string
required
The organization ID.

Path Parameters

phone_number_id
string
required
The unique identifier of the phone number to delete.

Permissions

  • phone_numbers:delete (admin, agent_manager)

Response

success
boolean
Indicates if the deletion was successful.
message
string
Human-readable success message.
data
object
The deleted phone number object.
{
  "success": true,
  "message": "Phone number deleted successfully",
  "data": {
    "phone_number_id": "phon_a1b2c3d4e5f6",
    "phone_number": "+15551234567",
    "provider": "twilio",
    "status": "free",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T15:00:00Z"
  }
}

Errors

400
object
Cannot delete assigned phone number. Unassign it first.
404
object
Phone number not found.
403
object
Phone number belongs to different organization.