Upsert entity types

Batched create-or-update of entity types. Existing types matched by id are updated; new ids are created. Idempotent — re-submitting the same payload converges to the same state.

PUT /api/v1-beta/entity-types

JavaScript

JavaScript

import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const response = await client.v1Beta.entityTypes.upsert({
  types: [
    {
      id: 'org',
      displayName: 'Organization',
      attributionKeys: ['organizationId'],
    },
    {
      id: 'team',
      displayName: 'Team',
      attributionKeys: ['teamId'],
    },
  ],
});

console.log(response.data);

200

{
  "data": [
    {
      "id": "org",
      "displayName": "Organization",
      "attributionKeys": [
        "organizationId"
      ],
      "createdAt": "2026-05-18T10:00:00.000Z",
      "updatedAt": "2026-05-18T10:00:00.000Z"
    }
  ]
}

Authorizations

X-API-KEY · string · header · required

Server API Key

Headers

X-ACCOUNT-ID · string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID · string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Body

application/json

Batched create-or-update of entity types. Idempotent — re-submitting the same payload converges.

types · UpsertEntityType · object[] · required

Entity types to upsert (1–100 per request)

Required array length: 1 - 100 elements

Show child attributes

Response

200

application/json

Entity types after upsert.

Entity types after upsert.

data · EntityType · object[] · required

Show child attributes