curl --request DELETE \
--url https://api.voxo.co/v2/admin/tenants/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.voxo.co/v2/admin/tenants/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.voxo.co/v2/admin/tenants/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voxo.co/v2/admin/tenants/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.voxo.co/v2/admin/tenants/{id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.voxo.co/v2/admin/tenants/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voxo.co/v2/admin/tenants/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"tenantCode": "<string>",
"externalBillingId": "<string>",
"billingStartDate": "<string>",
"conduitPrefix": "<string>",
"brandId": "<string>",
"brandVertical": "<string>",
"resellerType": "<string>",
"globalQueueActions": 123,
"queuePauseReasons": [
"<string>"
],
"parkinglotTimeout": 123,
"incomingRingsCount": 123,
"recordingStorage": "<string>",
"recordingHost": "<string>",
"recordingUser": "<string>",
"recordingPassword": "<string>",
"recordingDir": "<string>",
"salesforceDomain": "<string>",
"salesforceCTITasks": "<string>",
"autoPortReject": 123,
"callWaiting": 123,
"disabled": 123,
"enableSoftphonePark": 123,
"isResidential": 123,
"mfaEnabled": 123,
"recordUserSessions": 123,
"sameRing": 123,
"forceVoicemailPin": 123,
"billingV2": 123,
"healthcareVertical": "<string>",
"timezone": {
"id": 123,
"name": "<string>"
},
"musicOnHold": {
"id": 123,
"name": "<string>"
},
"routingProfile": {
"id": 123,
"name": "<string>"
},
"partner": {
"id": 123,
"name": "<string>",
"tenantId": 123
},
"branch": {
"id": 123,
"name": "<string>"
},
"isResellerAccount": 123,
"parkinglotCount": 123,
"notes": [
{
"id": 123,
"name": "<string>",
"note": "<string>",
"userId": 123
}
],
"products": [
{
"id": 123,
"productId": 123,
"name": "<string>",
"description": "<string>",
"price": "<string>",
"customQuantity": 123,
"customDescription": "<string>",
"isCustom": true,
"tenantId": 123
}
],
"integrations": [
{
"id": 123,
"name": "<string>",
"category": "<string>"
}
],
"billingInfo": {
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"conduits": [
{
"id": 123,
"name": "<string>",
"conduitPrefix": "<string>"
}
]
}{
"name": "<string>",
"message": "<string>",
"code": 123,
"validationErrors": [
"<string>"
]
}{
"name": "<string>",
"message": "<string>",
"code": 123,
"validationErrors": [
"<string>"
]
}Delete Tenant
Delete a tenant by ID
curl --request DELETE \
--url https://api.voxo.co/v2/admin/tenants/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.voxo.co/v2/admin/tenants/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.voxo.co/v2/admin/tenants/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voxo.co/v2/admin/tenants/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.voxo.co/v2/admin/tenants/{id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.voxo.co/v2/admin/tenants/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voxo.co/v2/admin/tenants/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"tenantCode": "<string>",
"externalBillingId": "<string>",
"billingStartDate": "<string>",
"conduitPrefix": "<string>",
"brandId": "<string>",
"brandVertical": "<string>",
"resellerType": "<string>",
"globalQueueActions": 123,
"queuePauseReasons": [
"<string>"
],
"parkinglotTimeout": 123,
"incomingRingsCount": 123,
"recordingStorage": "<string>",
"recordingHost": "<string>",
"recordingUser": "<string>",
"recordingPassword": "<string>",
"recordingDir": "<string>",
"salesforceDomain": "<string>",
"salesforceCTITasks": "<string>",
"autoPortReject": 123,
"callWaiting": 123,
"disabled": 123,
"enableSoftphonePark": 123,
"isResidential": 123,
"mfaEnabled": 123,
"recordUserSessions": 123,
"sameRing": 123,
"forceVoicemailPin": 123,
"billingV2": 123,
"healthcareVertical": "<string>",
"timezone": {
"id": 123,
"name": "<string>"
},
"musicOnHold": {
"id": 123,
"name": "<string>"
},
"routingProfile": {
"id": 123,
"name": "<string>"
},
"partner": {
"id": 123,
"name": "<string>",
"tenantId": 123
},
"branch": {
"id": 123,
"name": "<string>"
},
"isResellerAccount": 123,
"parkinglotCount": 123,
"notes": [
{
"id": 123,
"name": "<string>",
"note": "<string>",
"userId": 123
}
],
"products": [
{
"id": 123,
"productId": 123,
"name": "<string>",
"description": "<string>",
"price": "<string>",
"customQuantity": 123,
"customDescription": "<string>",
"isCustom": true,
"tenantId": 123
}
],
"integrations": [
{
"id": 123,
"name": "<string>",
"category": "<string>"
}
],
"billingInfo": {
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"conduits": [
{
"id": 123,
"name": "<string>",
"conduitPrefix": "<string>"
}
]
}{
"name": "<string>",
"message": "<string>",
"code": 123,
"validationErrors": [
"<string>"
]
}{
"name": "<string>",
"message": "<string>",
"code": 123,
"validationErrors": [
"<string>"
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Tenant ID
^[1-9]\d*$Response
Deleted tenant
Tenant ID
Tenant name
Tenant code
External billing ID
Billing start date
Conduit prefix
Brand ID
Brand vertical
Reseller type (RESELLER or WHITELABEL)
Global queue actions flag
Queue pause reasons
Parking lot timeout in seconds
Incoming rings count
Recording storage type (DEFAULT or AWS3)
Recording host URL
Recording storage username
Recording storage password
Recording storage directory
Salesforce domain URL
Salesforce CTI tasks setting
Auto port reject flag
Call waiting flag
Whether tenant is disabled (1 = yes, 0 = no)
Enable softphone park flag
Whether tenant is residential
Whether MFA is enabled
Whether user sessions are recorded
Same ring flag
Force voicemail PIN flag
Whether billing V2 is enabled
Healthcare vertical (e.g. pharmacy)
Timezone details
Show child attributes
Show child attributes
Music on hold details
Show child attributes
Show child attributes
Routing profile details
Show child attributes
Show child attributes
Partner details
Show child attributes
Show child attributes
Default branch details
Show child attributes
Show child attributes
Whether this is a reseller account (1 = yes, 0 = no)
Number of parking lot spaces
Account notes
Show child attributes
Show child attributes
Product pricing entries
Show child attributes
Show child attributes
Active integrations
Show child attributes
Show child attributes
Billing contact info mapped from QuickBooks customer
Show child attributes
Show child attributes
Configured conduits
Show child attributes
Show child attributes
Was this page helpful?