Skip to main content
DELETE
/
api
/
v1
/
accounts
/
{auth_id}
/
sub-accounts
/
{sub_auth_id}
Delete a sub-account
curl --request DELETE \
  --url https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id} \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'
{
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

DELETE https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}
Permanently deletes a subaccount and all its associated credentials.
Authentication required:
  • X-Auth-ID - Your account Auth ID
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json
Warning: Deleting a subaccount is permanent. This action cannot be undone. Ensure you have backed up any necessary data before proceeding.

Parameters

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

Request

cURL
curl -X DELETE 'https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}' \
--header 'X-Auth-ID: {auth_id}' \
--header 'X-Auth-Token: {auth_token}'

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.

Authorizations

X-Auth-ID
string
header
required

Your Vobiz account Auth ID

X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Path Parameters

auth_id
string
required

Your account Auth ID

Example:

"MA_XXXXXX"

sub_auth_id
string
required

Response

Success

message
string
required