Delete trunk credential
delete_trunk_credentialPermanently delete a Vobiz trunk credential to revoke SIP authentication, remove it from referencing trunks, and refuse future PBX or device access. Requires explicit confirmation.
Instructions
Delete a trunk credential from this Vobiz account; this cannot be undone. Any PBX or device authenticating with it is refused from then on, and trunks that referenced it lose that credential; Vobiz may refuse while it is in use by active calls. To pause access and keep the credential, use update_trunk_credential with enabled: false. An unknown credential_id raises not_found. Gated by VOBIZ_ENABLE_PROVISIONING and confirm: true.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | Yes | Must be true, set only after the user explicitly approved: deleting this trunk credential. | |
| credential_id | Yes | Trunk credential UUID: the id from list_trunk_credentials or create_trunk_credential. Unknown ids raise not_found. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | No | True on success. On a failure the result is isError with ok: false plus `error` (kind), `message`, `retryable` and sometimes `http_status`. | |
| deleted | No | ||
| http_status | No | HTTP status Vobiz answered with. | |
| credential_id | No | The credential that was deleted. |