Upsert assignments

Batched create-or-update of capability assignments. Existing assignments matched by (entityId, capabilityId) are updated; new pairs are created. On update, omitted fields (usageLimit, cadence) are preserved; on create both are required by the governance service.

PUT /api/v1-beta/customers/{id}/assignments

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.customers.assignments.upsert('id', {
  assignments: [
    {
      entityId: 'workspace-001',
      featureId: 'compute-minutes',
      usageLimit: 1000,
      cadence: 'MONTH',
    },
    {
      entityId: 'workspace-002',
      currencyId: 'cred-type-tokens',
      usageLimit: 2000,
      cadence: 'MONTH',
      parentId: 'workspace-001',
      scopeEntityIds: ['user-1'],
    },
  ],
});

console.log(response.data);

200

{
  "data": [
    {
      "id": "6f6b9c39-3a14-4a5e-9c6c-2a4f8d8d2f3f",
      "entityId": "workspace-001",
      "featureId": "feature-compute-minutes",
      "currencyId": "example-external-id",
      "scopeEntityIds": [],
      "parentId": null,
      "usageLimit": 1000,
      "cadence": "MONTH",
      "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).

Path Parameters

id · string · required

The customer identifier (owner) the assignments belong to

Required string length: 1 - 255

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$

Body

application/json

Request body for creating or updating capability assignments in bulk for a single customer

assignments · UpsertAssignment · object[] · required

Assignments to upsert (1–100 per request)

Required array length: 1 - 100 elements

Show child attributes

Response

200

application/json

Assignments after upsert.

Assignments after upsert.

data · Assignment · object[] · required

Show child attributes