Update a child organisation

cURL

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

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.organisations.updateSettingsOrganisation('ORG-0002', {organization: {}});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->organisations->updateSettingsOrganisation('ORG-0002', [
    '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().updateSettingsOrganisation(
        "ORG-0002",
        Map.of("organization", Map.of()));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

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

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.organisations.updateSettingsOrganisation(
  'ORG-0002',
  {'organization': {}},
);
print(response.map);

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

PATCH

settings

organisations

{organisation_id}

cURL

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

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.organisations.updateSettingsOrganisation('ORG-0002', {organization: {}});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->organisations->updateSettingsOrganisation('ORG-0002', [
    '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().updateSettingsOrganisation(
        "ORG-0002",
        Map.of("organization", Map.of()));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

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

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.organisations.updateSettingsOrganisation(
  'ORG-0002',
  {'organization': {}},
);
print(response.map);

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

Pass the organisation’s id as organisation_id and send the fields to change under organization. A successful call returns 200. 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.

Path Parameters

organisation_id

string

required

The child organisation's id, from the listing.

Body

application/json

organization

object

required

The organisation's fields.

Response

200

The updated child organisation.

Guides

API reference

Authorizations

Path Parameters

Body

Response