Update a Subaccount

PUThttps://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}

Updates the sub-account object by setting the values to the parameters passed. Parameters that are not provided remain unchanged.

Authentication Required:

• X-Auth-ID: Your account ID (e.g., {Auth_ID})
• X-Auth-Token: Your account Auth Token
• Content-Type: application/json

Note: Use this endpoint to update sub-account settings like description, rate limits, or permissions. Setting is_active=false would disable the sub-account if that field is supported.

Parameters

Request Parameters

Parameter	Type	Description
`name`optional	string	Name of the sub-account.
`email`optional	string	Email address associated with the subaccount.
`phone`optional	string	Phone number associated with the subaccount.
`description`optional	string	Description of the sub-account purpose or usage.
`rate_limit`optional	integer	API rate limit for this sub-account (requests per time period).
`permissions`optional	object	Permissions object defining what the sub-account can access. Contains boolean fields like "calls" and "cdr".
`enabled`optional	boolean	Whether the subaccount is active and enabled for use.

Request

cURL

curl -X PUT 'https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}' \
--header 'X-Auth-ID: {auth_id}' \
--header 'X-Auth-Token: {auth_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "description": "Updated permissions",
  "rate_limit": 750,
  "email": "updated@example.com",
  "enabled": true
}'

Request Body

JSON

{
  "description": "Updated permissions",
  "rate_limit": 750,
  "email": "updated@example.com",
  "enabled": true
}

Response Example

Success Response (200 OK)

{
  "name": "Support Team",
  "email": "updated@example.com",
  "phone": "+1234567890",
  "description": "Updated permissions",
  "permissions": {
    "calls": true,
    "cdr": true
  },
  "rate_limit": 750,
  "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:59:52.261439Z",
  "created_at": "2025-10-22T03:57:35.997500Z",
  "updated_at": "2025-10-22T03:59:52.261439Z",
  "account": "/api/v1/accounts/{auth_id}/",
  "resource_uri": "/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}/",
  "last_used": null
}

Complete Object Returned: The response returns the full updated sub-account object, not just a success message. Notice the updated_at timestamp has changed to reflect the modification.

Retrieve a Subaccount

Delete a Subaccount