Delete a Subaccount

DELETE

api

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>'

import requests

url = "https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}"

headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>"
}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "message": "<string>"
}

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.

Lost the sub-account credentials?

You do not need the sub-account’s own auth_id / auth_token to delete it. This endpoint authenticates as the parent (X-Auth-ID / X-Auth-Token of your MA_… account), and the sub-account is identified by the {sub_auth_id} in the path. So even if the credentials returned at creation were lost, the parent can still find and remove the sub-account.

List your sub-accounts to find the SA_ id

Call List Sub-Accounts and identify the one to remove by its name, email, or created timestamp.

curl -X GET 'https://api.vobiz.ai/api/v1/accounts/{MA_AUTH_ID}/sub-accounts/?active_only=true' \
--header 'X-Auth-ID: {MA_AUTH_ID}' \
--header 'X-Auth-Token: {MA_AUTH_TOKEN}'

Delete it by its SA_ auth id

Use the auth_id (SA_…) from the listing as {sub_auth_id}:

curl -X DELETE 'https://api.vobiz.ai/api/v1/accounts/{MA_AUTH_ID}/sub-accounts/{SA_AUTH_ID}' \
--header 'X-Auth-ID: {MA_AUTH_ID}' \
--header 'X-Auth-Token: {MA_AUTH_TOKEN}'

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

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>'

import requests

url = "https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}"

headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>"
}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "message": "<string>"
}

​Parameters

​Request

​Response Example

​Lost the sub-account credentials?

Authorizations

Path Parameters

Response

Parameters

Request

Response Example

Lost the sub-account credentials?