Delete a Subaccount

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

Permanently deletes a Subaccount. This action removes the sub-account and all its associated credentials.

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

Warning: Deleting a subaccount is permanent. This action cannot be undone. Ensure you have backed up any necessary data before proceeding.

Request

cURL
curl -X DELETE '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}'

Parameters

No request body or parameters required. The sub-account ID is specified in the URL path.

Response Example

Success Response (200 OK)
{
  "message": "Sub-account deleted successfully"
}

Success: The API returns a 200 OK status with a confirmation message when the sub-account is successfully deleted.