Update sub-account
update_sub_accountUpdate a Vobiz sub-account's name, contact, rate limit, permissions, enabled status, or KYC mode. Only provided fields change; customer_use requires an email and may pause calls until KYC verifies.
Instructions
Change a Vobiz sub-account's name, contact details, rate limit, permissions, enabled flag or kyc_mode. Only the fields you pass change. Moving to customer_use needs an email on the sub-account and can pause its calls until its KYC is verified. Gated by VOBIZ_ENABLE_PROVISIONING and confirm: true.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Human-readable name for the sub-account. | |
| No | Contact email. Required for kyc_mode customer_use. | ||
| phone | No | ||
| confirm | Yes | Must be true, set only after the user explicitly approved: changing this sub-account. | |
| enabled | No | Whether the sub-account can be used (default true). | |
| kyc_mode | No | personal_use (default) uses the parent's KYC; customer_use means the sub-account completes its own KYC before placing calls (needs email). | |
| rate_limit | No | API rate limit for the sub-account (Vobiz default 1000). | |
| description | No | ||
| permissions | No | Access flags. Omitted on create: the sub-account inherits the parent's default access. | |
| sub_auth_id | Yes | The sub-account's Auth ID (SA_...), from list_sub_accounts. |