Update a team

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/teams/team_0000000000000001000000000000a1b2" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "team": {
      "display_name": "Field Services North",
      "description": "Northern region crew"
    }
  }'

from exsited import build_client

client = build_client()

response = client.teams.update_settings_team(
    "team_0000000000000001000000000000a1b2",
    {
        "team": {
            "display_name": "Field Services North",
            "description": "Northern region crew",
        }
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.teams.updateSettingsTeam('team_0000000000000001000000000000a1b2', {
    team: {display_name: 'Field Services North', description: 'Northern region crew'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->teams->updateSettingsTeam('team_0000000000000001000000000000a1b2', [
    'team' => ['display_name' => 'Field Services North', 'description' => 'Northern region crew'],
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.teams.teams_dto.TeamsDto.SettingsTeam;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsTeam> response = client.teams().updateSettingsTeam(
        "team_0000000000000001000000000000a1b2",
        Map.of(
                "team", Map.of(
                        "display_name", "Field Services North",
                        "description", "Northern region crew")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Teams.UpdateSettingsTeamAsync(
    "team_0000000000000001000000000000a1b2",
    new Dictionary<string, object?>
    {
        ["team"] = new Dictionary<string, object?>
        {
            ["display_name"] = "Field Services North",
            ["description"] = "Northern region crew",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.teams.updateSettingsTeam(
  'team_0000000000000001000000000000a1b2',
  {
    'team': {
      'display_name': 'Field Services North',
      'description': 'Northern region crew',
    },
  },
);
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.Teams().UpdateSettingsTeam(context.Background(), "team_0000000000000001000000000000a1b2", map[string]any{
	"team": map[string]any{
		"display_name": "Field Services North",
		"description":  "Northern region crew",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "team": {
    "created_by": null,
    "created_on": "<string>",
    "description": "<string>",
    "display_name": "<string>",
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": null,
    "last_updated_on": "<string>",
    "managed_by": null,
    "name": "<string>",
    "object": "<string>",
    "status": "<string>",
    "version": null
  }
}

PATCH

settings

teams

{team_id}

cURL

curl -X PATCH "$EXSITED_BASE_URL/api/v4/settings/teams/team_0000000000000001000000000000a1b2" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "team": {
      "display_name": "Field Services North",
      "description": "Northern region crew"
    }
  }'

from exsited import build_client

client = build_client()

response = client.teams.update_settings_team(
    "team_0000000000000001000000000000a1b2",
    {
        "team": {
            "display_name": "Field Services North",
            "description": "Northern region crew",
        }
    },
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.teams.updateSettingsTeam('team_0000000000000001000000000000a1b2', {
    team: {display_name: 'Field Services North', description: 'Northern region crew'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->teams->updateSettingsTeam('team_0000000000000001000000000000a1b2', [
    'team' => ['display_name' => 'Field Services North', 'description' => 'Northern region crew'],
]);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.teams.teams_dto.TeamsDto.SettingsTeam;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsTeam> response = client.teams().updateSettingsTeam(
        "team_0000000000000001000000000000a1b2",
        Map.of(
                "team", Map.of(
                        "display_name", "Field Services North",
                        "description", "Northern region crew")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Teams.UpdateSettingsTeamAsync(
    "team_0000000000000001000000000000a1b2",
    new Dictionary<string, object?>
    {
        ["team"] = new Dictionary<string, object?>
        {
            ["display_name"] = "Field Services North",
            ["description"] = "Northern region crew",
        },
    });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.teams.updateSettingsTeam(
  'team_0000000000000001000000000000a1b2',
  {
    'team': {
      'display_name': 'Field Services North',
      'description': 'Northern region crew',
    },
  },
);
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.Teams().UpdateSettingsTeam(context.Background(), "team_0000000000000001000000000000a1b2", map[string]any{
	"team": map[string]any{
		"display_name": "Field Services North",
		"description":  "Northern region crew",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "team": {
    "created_by": null,
    "created_on": "<string>",
    "description": "<string>",
    "display_name": "<string>",
    "href": "<string>",
    "id": "<string>",
    "last_updated_by": null,
    "last_updated_on": "<string>",
    "managed_by": null,
    "name": "<string>",
    "object": "<string>",
    "status": "<string>",
    "version": null
  }
}

Send the fields to change under team, such as display_name or description. To enable or disable the team, send status as active or inactive. The updated team comes back under team.

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

team_id

string

required

The team's id, which starts with team_.

Body

application/json

team

object

required

Show child attributes

Response

200 - application/json

The updated team, under team.

team

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Body

Response