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.

Subaccounts let you manage multiple customer accounts under a single parent Account. Use them to segment, manage, and track each user’s usage independently.

​
Base URI

https://api.vobiz.ai/api/v1/Account/{auth_id}/Subaccount/

​
Key features

  • Complete resource isolation with dedicated auth credentials for secure multi-tenancy
  • Independent management of trunks, numbers, CDRs, and balances per subaccount
  • Parent account retains full administrative control over all subaccount operations
  • Each subaccount receives unique auth_id and auth_token for API access

​
Subaccount Operations

The Subaccount Object

View the structure and attributes of the Subaccount object including auth credentials, enabled status, and resource URI.

Create a Subaccount

POST request to create a new subaccount with a name and enabled status. Returns unique auth credentials.

Retrieve a Subaccount

GET request to retrieve details of a specific subaccount including auth credentials and settings.

Update a Subaccount

PUT request to update subaccount name or enabled status. Disabling blocks all API calls and trunk usage.

Delete a Subaccount

DELETE request to permanently remove a subaccount. Optionally cascade delete or reassociate resources.

List All Subaccounts

GET request to retrieve all subaccounts with pagination support. Sorted by creation date.

​
Subaccount Use Cases

Multi-Tenant SaaS

Create a subaccount for each customer. Each customer gets isolated resources and its own API credentials for programmatic access.

Department Isolation

Create subaccounts for different departments (Sales, Support, Operations). Each department gets its own trunks and phone numbers.

Reseller Model

Create subaccounts for resellers who manage their own customers. Track usage and billing separately per subaccount.

Development/Staging

Create subaccounts for dev, staging, and production environments. Test changes in isolation without affecting production.