Batch Create/Update People

import { TrebellarApiClient } from "@trebellar/api-sdk";
async function main() {
    const client = new TrebellarApiClient({
        environment: "https://api.trebellar.app",
    });
    await client.people.upsertPeopleBatch({
        people: [
            {
                externalId: "EMP001",
                name: "Jane Smith",
                employmentStatus: "active",
            },
            {
                id: "emp_existing_123",
                name: "John Updated",
                employmentStatus: "active",
            },
        ],
    });
}
main();

{
  "data": [
    {
      "id": "string",
      "groups": [
        {
          "id": "string",
          "name": "string",
          "path": "string",
          "parentId": "string",
          "avatarUrl": "string",
          "description": "string",
          "properties": {
            "color": "#FF5722"
          },
          "externalId": "string"
        }
      ],
      "externalId": "string",
      "assetId": "st_sf_tower_01",
      "name": "string",
      "hireDate": 1.1,
      "employmentStatus": "active",
      "terminationDate": 1.1,
      "address": {
        "raw": "123 Main St, Apt 4B, San Francisco, CA 94105",
        "postalCode": "94105",
        "streetName": "Main St",
        "city": "San Francisco",
        "state": "CA",
        "countryIso": "US"
      },
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}

Create new people or update existing employee records in a single batch operation. Use this for HR system integrations, bulk imports, or synchronized employee data updates. Each person record can include employment details, contact information, and initial group assignments. Existing people are matched by ID and updated; new records without IDs are created.

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.

peoplelist of objectsRequired

Response

All people records processed successfully - existing employees updated and new employees created

datalist of objects

Authentication

Request

Response

Errors