Delete an organisation

Delete an organisation

DELETE /admin/organisations/{orgID}

Delete an organisation

cURL

curl --request DELETE \
  --url https://{tenant}/admin/organisations/{orgID} \
  --header 'Admin-Auth: <api-key>'

import requests

url = "https://{tenant}/admin/organisations/{orgID}"

headers = {"Admin-Auth": "<api-key>"}

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

print(response.text)

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

fetch('https://{tenant}/admin/organisations/{orgID}', 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://{tenant}/admin/organisations/{orgID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Admin-Auth: <api-key>"
  ],
]);

$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://{tenant}/admin/organisations/{orgID}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Admin-Auth", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://{tenant}/admin/organisations/{orgID}")
  .header("Admin-Auth", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}/admin/organisations/{orgID}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Admin-Auth"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "Message": "Org deleted",
  "Meta": null,
  "Status": "OK"
}

{
  "Message": "Could not delete the org",
  "Meta": null,
  "Status": "Error"
}

{
  "Message": "Not authorised",
  "Meta": null,
  "Status": "Error"
}

{
  "Message": "Could not retrieve org detail",
  "Meta": null,
  "Status": "Error"
}

Authorizations

Admin-Auth · string · header · required

Api key

Path Parameters

orgID · string · required

Organisation ID of the org to add, update, or delete.

Response

200

application/json

OK

ID · string

Message · string

Meta · any

Status · string