Update People Group

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

{
  "id": "grp_engineering_team",
  "name": "Engineering Team",
  "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

idstringOptional

pathstringOptional

parentIdstringOptional

avatarUrlstringOptional

descriptionstringOptional

propertiesobjectOptional

Custom properties for group visualization and categorization

externalIdstringOptional

Response

People group updated successfully

idstring

namestring

pathstring or null

parentIdstring or null

avatarUrlstring or null

descriptionstring or null

propertiesobject or null

Custom properties for group visualization and categorization

externalIdstring or null

Authentication

Path parameters

Request

Response

Errors