Delete a child organisation

cURL

curl -X DELETE "$EXSITED_BASE_URL/api/v4/settings/organisations/ORG-0002" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.organisations().deleteSettingsOrganisation("ORG-0002");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Organisations.DeleteSettingsOrganisationAsync("ORG-0002");

Console.WriteLine(response.Json);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Organisations().DeleteSettingsOrganisation(context.Background(), "ORG-0002", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

DELETE

settings

organisations

{organisation_id}

cURL

curl -X DELETE "$EXSITED_BASE_URL/api/v4/settings/organisations/ORG-0002" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.organisations().deleteSettingsOrganisation("ORG-0002");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Organisations.DeleteSettingsOrganisationAsync("ORG-0002");

Console.WriteLine(response.Json);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Organisations().DeleteSettingsOrganisation(context.Background(), "ORG-0002", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

Pass the organisation’s id as organisation_id. A successful call returns 204.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

organisation_id

string

required

The child organisation's id, from the listing.

Response

204

The child organisation is deleted. No body.

Guides

API reference

Authorizations

Path Parameters

Response