Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

When a DID (phone number) is assigned to a sub-account, Vobiz enforces a 15-day cool-off period after the last call on that number. During the cool-off window, the DID cannot be unassigned from the sub-account and moved back to the parent pool. This protects against number-recycling abuse and ensures continuity for the sub-account’s customers.
DIDs that have never been used (no call history) are exempt from the cool-off and can be unassigned immediately.

​
Assign a DID to a sub-account

Move a number from the parent pool to a specific sub-account. 
POST /api/v1/account/{parent_auth_id}/numbers/{e164}/assign-subaccount
X-Auth-ID: {parent_auth_id}
X-Auth-Token: {parent_auth_token}
Content-Type: application/json
Request body
FieldTypeRequiredDescription
sub_account_idstringYesThe SA_ identifier of the sub-account to assign the number to
{
  "sub_account_id": "SA_xxxxxxxx"
}
Response (200/204) - the number is now assigned to the sub-account.

​
Unassign a DID (cool-off enforced)

Move a number back from a sub-account to the parent pool. 
DELETE /api/v1/account/{parent_auth_id}/numbers/{e164}/assign-subaccount
X-Auth-ID: {parent_auth_id}
X-Auth-Token: {parent_auth_token}
Success (200/204) - the number has been returned to the parent pool.

​
Cool-off error

If the DID had a call within the last 15 days, the request returns 409:
409 Conflict
{
  "error": "did_cool_off_in_effect",
  "cool_off_until": "2025-06-09T14:23:00Z",
  "cool_off_remaining_seconds": 1123200
}
FieldDescription
errorAlways did_cool_off_in_effect when blocked
cool_off_untilISO 8601 timestamp when the cool-off expires
cool_off_remaining_secondsRemaining cool-off duration in seconds
Wait until cool_off_until and retry the unassign request.

​
Summary

ScenarioResult
DID never used (last_call_at is null)Unassigned immediately
DID last used more than 15 days agoUnassigned immediately
DID last used within 15 days409 did_cool_off_in_effect

Phone Numbers

List and manage numbers on your account

Sub-Accounts

Sub-account object reference

Purchase Number

Buy numbers from the Vobiz inventory