Add People Group | trebellar

import { TrebellarApiClient } from "@trebellar/api-sdk";
async function main() {
    const client = new TrebellarApiClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.peopleGroups.addPeopleGroup({
        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.

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

Successful people-group inserted

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