Update People Group

import { TrebellarApiClient } from "@trebellar/api-sdk";
async function main() {
    const client = new TrebellarApiClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.peopleGroups.updatePeopleGroup("groupId", {
        body: {
            name: "Engineering Team",
            status: "PEOPLE_GROUP_STATUS_ACTIVE",
            parentId: "grp_technology_dept",
            description: "Software development and infrastructure team",
            properties: {
                color: "#2196F3",
            },
            externalId: "DEPT_ENG",
        },
    });
}
main();

{
  "id": "grp_engineering_team",
  "name": "Engineering Team",
  "status": "PEOPLE_GROUP_STATUS_UNKNOWN",
  "path": "/departments/technology/engineering",
  "parentId": "grp_technology_dept",
  "avatarUrl": "https://example.com/team-avatar.png",
  "description": "Software development and infrastructure team",
  "properties": {
    "color": "#2196F3"
  },
  "externalId": "DEPT_ENG"
}

import { TrebellarApiClient } from "@trebellar/api-sdk";
async function main() {
    const client = new TrebellarApiClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.peopleGroups.updatePeopleGroup("groupId", {
        body: {
            name: "Engineering Team",
            status: "PEOPLE_GROUP_STATUS_ACTIVE",
            parentId: "grp_technology_dept",
            description: "Software development and infrastructure team",
            properties: {
                color: "#2196F3",
            },
            externalId: "DEPT_ENG",
        },
    });
}
main();

{
  "id": "grp_engineering_team",
  "name": "Engineering Team",
  "status": "PEOPLE_GROUP_STATUS_UNKNOWN",
  "path": "/departments/technology/engineering",
  "parentId": "grp_technology_dept",
  "avatarUrl": "https://example.com/team-avatar.png",
  "description": "Software development and infrastructure team",
  "properties": {
    "color": "#2196F3"
  },
  "externalId": "DEPT_ENG"
}

Authentication

X-Trebellar-Api-Keystring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

groupIdstringRequired

Request

This endpoint expects an object.

namestringRequired

statusenumRequired

Allowed values:

idstringOptional

pathstringOptional

parentIdstringOptional

avatarUrlstringOptional

descriptionstringOptional

propertiesobjectOptional

Custom properties for group visualization and categorization

externalIdstringOptional

Response

People group updated successfully

idstring

namestring

statusenum

Allowed values:

pathstring

parentIdstring

avatarUrlstring

descriptionstring

propertiesobject

Custom properties for group visualization and categorization

externalIdstring

Errors

400

Bad Request Error

404

Not Found Error

500

Internal Server Error

1	import { TrebellarApiClient } from "@trebellar/api-sdk";
2
3	async function main() {
4	const client = new TrebellarApiClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.peopleGroups.updatePeopleGroup("groupId", {
8	body: {
9	name: "Engineering Team",
10	status: "PEOPLE_GROUP_STATUS_ACTIVE",
11	parentId: "grp_technology_dept",
12	description: "Software development and infrastructure team",
13	properties: {
14	color: "#2196F3",
15	},
16	externalId: "DEPT_ENG",
17	},
18	});
19	}
20	main();

1	{
2	"id": "grp_engineering_team",
3	"name": "Engineering Team",
4	"status": "PEOPLE_GROUP_STATUS_UNKNOWN",
5	"path": "/departments/technology/engineering",
6	"parentId": "grp_technology_dept",
7	"avatarUrl": "https://example.com/team-avatar.png",
8	"description": "Software development and infrastructure team",
9	"properties": {
10	"color": "#2196F3"
11	},
12	"externalId": "DEPT_ENG"
13	}