Update a Subaccount

PUThttps://api.vobiz.ai/api/v1/accounts/{account_id}/sub-accounts/{sub_account_id}

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

Authentication: Requires Bearer Token (JWT). Pass your access token in the Authorization header.

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

Name	Type	Description
`name`	string	Name of the sub-account.
`description`	string	Description of the sub-account purpose or usage.
`rate_limit`	integer	API rate limit for this sub-account (requests per time period).
`permissions`	object	Permissions object defining what the sub-account can access. Contains boolean fields like "calls" and "cdr".

Request

cURL

curl -X PUT 'https://api.vobiz.ai/api/v1/accounts/{account_id}/sub-accounts/{sub_account_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
}'

Request Body

JSON

{
  "description": "Updated permissions",
  "rate_limit": 500
}

Response Example

Success Response (200 OK)

{
  "name": "Support Team",
  "description": "Updated permissions",
  "permissions": {
    "calls": true,
    "cdr": true
  },
  "rate_limit": 500,
  "id": "SA_67401KW8",
  "parent_account_id": "{Auth_ID}",
  "auth_id": "inG9oUky5uFjdUECaQNzeyVYD6ommaJd",
  "is_active": true,
  "created_at": "2025-10-22T03:57:35.997500Z",
  "updated_at": "2025-10-22T03:59:52.261439Z",
  "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