Delete an Application

DELETE

api

Account

{auth_id}

Application

{app_id}

Delete an Application

curl --request DELETE \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Application/{app_id}/ \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Application/{app_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/Account/{auth_id}/Application/{app_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

"<string>"

{
  "api_id": "<string>",
  "error": "<string>",
  "message": "<string>"
}

{
  "api_id": "<string>",
  "error": "<string>",
  "message": "<string>"
}

DELETE https://api.vobiz.ai/api/v1/Account/{auth_id}/Application/{app_id}/

Permanently deletes an application.

Authentication required:

X-Auth-ID - Your account Auth ID
X-Auth-Token - Your account Auth Token
Content-Type: application/json

Warning: Deletion is permanent and cannot be undone. If the application is associated with phone numbers, the deletion is blocked with a 409 until those associations are removed.

Delete an app that is in use: first detach every number bound to it (and repoint any endpoints whose application is this app, via update endpoint), then call delete. Deleting a default_number_app/default_endpoint_app removes the auto-routing default - set a new default on another application beforehand if you rely on it.

Arguments

No request parameters needed.

Response Examples

Success Response (204 No Content) - No response body.

{
  "error": "Application not found",
  "app_id": "12345678901234567"
}

{
  "error": "Cannot delete application",
  "message": "Application is currently in use by 5 phone numbers"
}

cURL Example

cURL

curl -X DELETE https://api.vobiz.ai/api/v1/Account/{auth_id}/Application/12345678901234567/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_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"

app_id

string

required

Example:

"12345678"

Response

Success

The response is of type string.

Delete an Application

curl --request DELETE \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Application/{app_id}/ \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Application/{app_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/Account/{auth_id}/Application/{app_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

"<string>"

{
  "api_id": "<string>",
  "error": "<string>",
  "message": "<string>"
}

{
  "api_id": "<string>",
  "error": "<string>",
  "message": "<string>"
}

​Arguments

​Response Examples

​cURL Example

Authorizations

Path Parameters

Response

Arguments

Response Examples

cURL Example