Phone Numbers
Release phone number
Release a phone number and cancel its subscription
On this page
This endpoint releases a phone number from your account. For dedicated numbers with subscriptions, this cancels the subscription and the number will be released at the end of the current billing period.
Path Parameters
idintegerrequired
The unique identifier of the phone number to release
Response
messagestring
Success message indicating the release status
{
"message": "Phone number released successfully. It will be removed at the end of the billing period."
}
{
"message": "Phone number deleted successfully."
}
{
"error": "Phone number is already scheduled for release."
}
{
"error": "Phone number not found."
}
{
"error": "Failed to release phone number. Please try again or contact support."
}
Release Behavior
The release behavior depends on the phone number type:
| Type | Behavior |
|---|---|
| Dedicated (normal) | Subscription is cancelled. Number remains active until the end of the billing period, then is released. |
| SIP | Immediately deleted from your account. |
| Caller ID | Immediately deleted from your account and removed from the telephony provider. |
Once a phone number is released, you may not be able to get the same number back. Make sure to update any assistants or campaigns using this number before releasing it.
What Happens to Attached Resources
When you release a phone number:
- Any inbound assistants attached to this number will have their phone number unassigned
- Any campaigns using this number will have it removed from their phone number rotation
- Call history is preserved and remains accessible
Related guides
Phone Numbers
Types of Phone Numbers
Learn about the different types of phone numbers you can use with VoxLink.ai: dedicated numbers, SIP integration, and Caller ID
Read guide →Phone Numbers
Purchasing & Managing Numbers
Learn how to purchase, provision, and manage phone numbers for your AI assistants
Read guide →Phone Numbers
SMS Capabilities
Learn about SMS features, requirements, and pricing for your phone numbers
Read guide →Phone Numbers
Assigning Numbers to Assistants
Learn how to connect your phone numbers to AI assistants for both inbound and outbound calls
Read guide →