---
title: "Update a sub-account"
method: PUT
path: "/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}"
tags: ["Sub-Accounts"]
---

# Update a sub-account

`PUT /api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}`

## Request

- Base URL: `https://api.vobiz.ai`
- URL: `https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}`
- Auth: API key in header `X-Auth-ID` and API key in header `X-Auth-Token`
- TypeScript: <https://skmtc.dev/vobiz/apis/vobiz-api/docs/api/v1/accounts/:auth_id/sub-accounts/:sub_auth_id/put.ts> (a function with typed inputs; its response is checked against the schema)

Update the name or status of a sub-account, or change its `kyc_mode`.

Promoting an existing sub-account to `customer_use` requires the
sub-account to already have an `email` (otherwise `400`). On any
`kyc_mode` change, `kyc_calls_blocked` is re-derived from the
sub-account's current KYC state.

## Path parameters

- `auth_id` string, required
- `sub_auth_id` string, required

## Request body

- object
  - `name` string
  - `enabled` boolean
  - `kyc_mode` 'personal_use' | 'customer_use': Change the verification mode. Promoting to `customer_use` requires the sub-account to have an `email`.

## Response `200`

Sub-account updated

- object
  - `name` string, required
  - `email` unknown, required
  - `phone` unknown, required
  - `description` unknown, required
  - `permissions` unknown, required
  - `rate_limit` integer, required
  - `id` string, required
  - `parent_account_id` string, required
  - `parent_auth_id` string, required
  - `auth_id` string, required
  - `auth_token` string, required
  - `api_id` string, required
  - `email_verified` boolean, required
  - `enabled` boolean, required
  - `created` string, required
  - `modified` string, required
  - `is_active` boolean, required
  - `created_at` string, required
  - `updated_at` string, required
  - `last_used` unknown, required
  - `account` string, required
  - `resource_uri` string, required

---

[API](https://skmtc.dev/vobiz/apis/vobiz-api.md) - [All operations](https://skmtc.dev/vobiz/apis/vobiz-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vobiz/apis/vobiz-api/revisions/863f08cd6737?raw)