Create an operator group

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/settings/operator_groups" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "operator_group": {
      "name": "Support",
      "display_name": "Support team",
      "description": "Handles customer support",
      "role": "3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73"
    }
  }'

from exsited import build_client

client = build_client()

response = client.operator_groups.create_settings_operator_group(
    {
        "operator_group": {
            "name": "Support",
            "display_name": "Support team",
            "description": "Handles customer support",
            "role": "3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73",
        },
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.operatorGroups.createSettingsOperatorGroup({
    operator_group: {
        name: 'Support',
        display_name: 'Support team',
        description: 'Handles customer support',
        role: '3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73',
    },
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->operatorGroups->createSettingsOperatorGroup(
    [
        'operator_group' => [
            'name' => 'Support',
            'display_name' => 'Support team',
            'description' => 'Handles customer support',
            'role' => '3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73',
        ],
    ],
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.operator_groups.operator_groups_dto.OperatorGroupsDto.SettingsOperatorGroup;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsOperatorGroup> response = client.operatorGroups().createSettingsOperatorGroup(
        Map.of("operator_group", Map.of("name", "Support",
                        "display_name", "Support team",
                        "description", "Handles customer support",
                        "role", "3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.OperatorGroups.CreateSettingsOperatorGroupAsync(
    new Dictionary<string, object?>
    {
        ["operator_group"] = new Dictionary<string, object?>
        {
            ["name"] = "Support",
            ["display_name"] = "Support team",
            ["description"] = "Handles customer support",
            ["role"] = "3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.operatorGroups.createSettingsOperatorGroup(
  {
    'operator_group': {
      'name': 'Support',
      'display_name': 'Support team',
      'description': 'Handles customer support',
      'role': '3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73',
    },
  },
);
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.OperatorGroups().CreateSettingsOperatorGroup(context.Background(), map[string]any{
	"operator_group": map[string]any{
		"name": "Support",
		"display_name": "Support team",
		"description": "Handles customer support",
		"role": "3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "operator_group": {
    "object": "<string>",
    "id": "<string>",
    "name": "<string>",
    "display_name": "<string>",
    "description": "<string>",
    "status": "<string>",
    "role": {
      "object": "<string>",
      "id": "<string>",
      "name": "<string>",
      "href": "<string>"
    },
    "departments": [
      {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "created_on": "<string>",
    "last_updated_on": "<string>",
    "created_by": "<unknown>",
    "last_updated_by": "<unknown>",
    "href": "<string>"
  }
}

POST

settings

operator_groups

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/settings/operator_groups" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "operator_group": {
      "name": "Support",
      "display_name": "Support team",
      "description": "Handles customer support",
      "role": "3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73"
    }
  }'

from exsited import build_client

client = build_client()

response = client.operator_groups.create_settings_operator_group(
    {
        "operator_group": {
            "name": "Support",
            "display_name": "Support team",
            "description": "Handles customer support",
            "role": "3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73",
        },
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.operatorGroups.createSettingsOperatorGroup({
    operator_group: {
        name: 'Support',
        display_name: 'Support team',
        description: 'Handles customer support',
        role: '3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73',
    },
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->operatorGroups->createSettingsOperatorGroup(
    [
        'operator_group' => [
            'name' => 'Support',
            'display_name' => 'Support team',
            'description' => 'Handles customer support',
            'role' => '3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73',
        ],
    ],
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.operator_groups.operator_groups_dto.OperatorGroupsDto.SettingsOperatorGroup;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsOperatorGroup> response = client.operatorGroups().createSettingsOperatorGroup(
        Map.of("operator_group", Map.of("name", "Support",
                        "display_name", "Support team",
                        "description", "Handles customer support",
                        "role", "3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.OperatorGroups.CreateSettingsOperatorGroupAsync(
    new Dictionary<string, object?>
    {
        ["operator_group"] = new Dictionary<string, object?>
        {
            ["name"] = "Support",
            ["display_name"] = "Support team",
            ["description"] = "Handles customer support",
            ["role"] = "3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.operatorGroups.createSettingsOperatorGroup(
  {
    'operator_group': {
      'name': 'Support',
      'display_name': 'Support team',
      'description': 'Handles customer support',
      'role': '3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73',
    },
  },
);
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.OperatorGroups().CreateSettingsOperatorGroup(context.Background(), map[string]any{
	"operator_group": map[string]any{
		"name": "Support",
		"display_name": "Support team",
		"description": "Handles customer support",
		"role": "3f6b8c2e-7a1d-4e95-b0c4-8d2a6f1e9b73",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "operator_group": {
    "object": "<string>",
    "id": "<string>",
    "name": "<string>",
    "display_name": "<string>",
    "description": "<string>",
    "status": "<string>",
    "role": {
      "object": "<string>",
      "id": "<string>",
      "name": "<string>",
      "href": "<string>"
    },
    "departments": [
      {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "created_on": "<string>",
    "last_updated_on": "<string>",
    "created_by": "<unknown>",
    "last_updated_by": "<unknown>",
    "href": "<string>"
  }
}

role is required and takes the role’s dashed uuid. The new group comes back under operator_group.

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

operator_group

object

required

Show child attributes

Response

201 - application/json

The new group, under operator_group.

operator_group

object

One operator group.

Show child attributes

Guides

API reference

Authorizations

Body

Response