Create a child organisation

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/settings/organisations" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "organization": {}
  }'

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->organisations->createSettingsOrganisation(['organization' => (object) []]);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.organisations().createSettingsOrganisation(
        Map.of("organization", Map.of()));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Organisations.CreateSettingsOrganisationAsync(new Dictionary<string, object?>
{
    ["organization"] = new Dictionary<string, object?>(),
});

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().CreateSettingsOrganisation(context.Background(), map[string]any{"organization": map[string]any{}}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

POST

settings

organisations

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/settings/organisations" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "organization": {}
  }'

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->organisations->createSettingsOrganisation(['organization' => (object) []]);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.organisations().createSettingsOrganisation(
        Map.of("organization", Map.of()));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Organisations.CreateSettingsOrganisationAsync(new Dictionary<string, object?>
{
    ["organization"] = new Dictionary<string, object?>(),
});

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().CreateSettingsOrganisation(context.Background(), map[string]any{"organization": map[string]any{}}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

Send the organisation under organization, spelled with a z. A create depends on your licence, changes the organisation hierarchy and assigns an existing user. A successful call returns 201. The fields a child organisation takes are not documented yet.

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. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.

Authorizations

Authorization

string

header

required

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

Body

application/json

organization

object

required

The organisation's fields.

Response

201

The new child organisation, under organization.

Guides

API reference

Authorizations

Body

Response