Skip to main content
POST
/
api
/
v1
/
accounts
/
{auth_id}
/
sub-accounts
Create a sub-account
curl --request POST \
  --url https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/ \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "name": "<string>",
  "enabled": true
}
'
{
  "message": "<string>",
  "sub_account": {
    "name": "<string>",
    "email": null,
    "phone": null,
    "description": null,
    "permissions": null,
    "rate_limit": 123,
    "id": "<string>",
    "parent_account_id": "<string>",
    "parent_auth_id": "<string>",
    "auth_id": "<string>",
    "auth_token": "<string>",
    "api_id": "<string>",
    "email_verified": true,
    "enabled": true,
    "created": "<string>",
    "modified": "<string>",
    "is_active": true,
    "created_at": "<string>",
    "updated_at": "<string>",
    "last_used": null,
    "account": "<string>",
    "resource_uri": "<string>"
  },
  "auth_credentials": {
    "auth_id": "<string>",
    "auth_token": "<string>"
  },
  "tokens": {
    "access_token": "<string>",
    "refresh_token": "<string>",
    "token_type": "<string>",
    "expires_in": 123
  }
}

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.

POST https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/
Provision isolated subaccounts under your main account for multi-tenant SaaS applications, reseller models, or departmental resource segregation.
Authentication required:
  • X-Auth-ID - Your account Auth ID
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json

​
Parameters

FieldTypeRequiredDescription
namestringYesA human-readable name for the subaccount.
emailstringYesEmail address associated with the subaccount.
phonestringNoPhone number associated with the subaccount.
descriptionstringNoDescription of the sub-account purpose or usage.
rate_limitintegerYesAPI rate limit for this sub-account (requests per time period).
permissionsobjectYesPermissions object defining what the sub-account can access. Contains boolean fields like calls and cdr.
passwordstringYesPassword for the sub-account authentication.
enabledbooleanNoWhether the subaccount is active and enabled for use.

​
Request

curl -X POST 'https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/' \
--header 'X-Auth-ID: {auth_id}' \
--header 'X-Auth-Token: {auth_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "Support Team",
  "email": "support@example.com",
  "phone": "+1234567890",
  "description": "Support-facing voice workload",
  "rate_limit": 500,
  "permissions": {
    "calls": true,
    "cdr": true
  },
  "password": "S0pport123!",
  "enabled": true
}'

​
Response Example

Success Response (201 Created)
{
  "message": "Sub-account created successfully",
  "sub_account": {
    "name": "Support Team",
    "email": "support@example.com",
    "phone": "+1234567890",
    "description": "Support-facing voice workload",
    "permissions": {
      "calls": true,
      "cdr": true
    },
    "rate_limit": 500,
    "id": "{sub_auth_id}",
    "parent_auth_id": "{auth_id}",
    "parent_auth_id": "{parent_auth_id}",
    "auth_id": "{auth_id}",
    "auth_token": "{auth_token}",
    "api_id": "{api_id}",
    "email_verified": true,
    "enabled": true,
    "is_active": true,
    "created": "2025-10-22T03:57:35.997500Z",
    "modified": "2025-10-22T03:57:35.997500Z",
    "created_at": "2025-10-22T03:57:35.997500Z",
    "updated_at": "2025-10-22T03:57:35.997500Z",
    "account": "/api/v1/accounts/{auth_id}/",
    "resource_uri": "/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}/",
    "last_used": null
  },
  "auth_credentials": {
    "auth_id": "{auth_id}",
    "auth_token": "{auth_token}"
  },
  "tokens": {
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "token_type": "bearer",
    "expires_in": 1800
  }
}
Success! The response contains three important sections:
  • sub_account - The created sub-account object with all details
  • auth_credentials - The auth_id and auth_token for API authentication - save these securely!
  • tokens - JWT access and refresh tokens for immediate API access
Security Note: The auth_token is only returned once during creation. Store it securely - you will not be able to retrieve it again. If lost, you will need to regenerate credentials.

Authorizations

​
X-Auth-ID
string
header
required

Your Vobiz account Auth ID

​
X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Path Parameters

​
auth_id
string
required

Your account Auth ID

Example:

"MA_XXXXXX"

Body

application/json
​
name
string
required
​
enabled
boolean
required

Response

Success

​
message
string
required
​
sub_account
object
required
​
auth_credentials
object
required
​
tokens
object
required