Update sub-account
update_sub_accountUpdate an existing Vobiz sub-account's name, contact details, description, rate limit, permissions, enabled flag, or KYC mode. Only provided fields change; others remain unchanged.
Instructions
Change an existing Vobiz sub-account's name, contact details, description, rate limit, permissions, enabled flag or kyc_mode. Only the fields you pass change; omitted fields keep their values, and a call with no fields fails with invalid_input. Moving to customer_use needs an email on the sub-account and can pause its calls until its KYC is verified. Returns the updated record with credentials removed. To make a new sub-account use create_sub_account; to remove one use delete_sub_account. Gated by VOBIZ_ENABLE_PROVISIONING and confirm: true; needs main-account (MA_) credentials.
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 | Contact phone number for the sub-account's owner: digits with an optional leading + and spaces, dashes or brackets, 6 to 20 characters. Not a caller ID. | |
| 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 | Free-text note about the sub-account (what or whom it is for), up to 1000 characters. | |
| 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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | No | true on success; false (with error and message) when the tool failed. | |
| updated | No | true once Vobiz applied the change. | |
| http_status | No | HTTP status Vobiz answered with. | |
| sub_account | No | ||
| sub_auth_id | No | The sub-account that was changed. |