Update a feature

Updates an existing feature’s properties such as display name, description, and configuration.

PATCH /api/v1/features/{id}

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 feature = await client.v1.features.updateFeature('x');

console.log(feature.data);

200

{
  "data": {
    "id": "feature-api-calls",
    "displayName": "API Calls",
    "description": "Number of API calls allowed per month",
    "featureType": "NUMBER",
    "meterType": "INCREMENTAL",
    "featureUnits": "call",
    "featureUnitsPlural": "calls",
    "featureStatus": "ACTIVE",
    "unitTransformation": null,
    "enumConfiguration": null,
    "metadata": {},
    "createdAt": "2025-10-26T10:00:00.000Z",
    "updatedAt": "2025-10-26T10: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 unique identifier of the entity

Required string length: 1 - 255

Body

application/json

Partially update an existing feature. Only provided fields are updated.

displayName · string

The display name for the feature

Maximum string length: 255

description · string

The description for the feature

Maximum string length: 255

featureUnits · string

The units for the feature

Maximum string length: 255

featureUnitsPlural · string

The plural units for the feature

Maximum string length: 255

metadata · object

The additional metadata for the feature

Show child attributes

unitTransformation · object

Unit transformation to be applied to the reported usage

Show child attributes

enumConfiguration · object[]

The configuration data for the feature

Required array length: 1 - 255 elements

Show child attributes

meter · object

Show child attributes

Response

200

application/json

The updated feature object.

Response object

data · Feature · object · required

Feature configuration object

Show child attributes