v1

latestOpenAPI 3.0.42026-07-13107171473.3 KB
Feature Flags & Settings

Update Flag

This endpoint updates the metadata of a Feature Flag or Setting with a collection of JSON Patch operations in a specified Config.

Only the name, hint and tags attributes are modifiable by this endpoint. The tags attribute is a simple collection of the tag IDs attached to the given setting.

The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change.

For example: We have the following resource.

{
  "settingId": 5345,
  "key": "myGrandFeature",
  "name": "Tihs is a naem with soem typos.",
  "hint": "This flag controls my grandioso feature.",
  "settingType": "boolean",
  "tags": [
    {
      "tagId": 0, 
      "name": "sample tag", 
      "color": "whale"
    }
  ]
}

If we send an update request body as below (it changes the name and adds the already existing tag with the id 2):

[
  {
    "op": "replace", 
    "path": "/name", 
    "value": "This is the name without typos."
  }, 
  {
    "op": "add", 
    "path": "/tags/-", 
    "value": 2
  }
]

Only the name and tags are updated and all the other attributes remain unchanged. So we get a response like this:

{
  "settingId": 5345, 
  "key": "myGrandFeature", 
  "name": "This is the name without typos.", 
  "hint": "This flag controls my grandioso feature.", 
  "settingType": "boolean", 
  "tags": [
    {
      "tagId": 0, 
      "name": "sample tag", 
      "color": "whale"
    }, 
    {
      "tagId": 2, 
      "name": "another tag", 
      "color": "koala"
    }
  ]
}
patch/v1/settings/{settingId}

Path parameters

settingIdinteger required

The identifier of the Setting.

Request body

op'unknown' | 'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test' required
pathstring required

The source path.

fromstring nullable

The target path.

{"stackTrail":"components:schemas:JsonPatchOperation:properties:value","oasType":"schema","type":"unknown","description":"The discrete value.","nullable":true}

Response

When the update was successful.

settingIdinteger required

Identifier of the Feature Flag or Setting.

keystring required

Key of the Feature Flag or Setting.

namestring required

Name of the Feature Flag or Setting.

hintstring nullable required

Description of the Feature Flag or Setting.

orderinteger required

The order of the Feature Flag or Setting represented on the ConfigCat Dashboard.

settingType'boolean' | 'string' | 'int' | 'double' required

The type of the Feature Flag or Setting.

isJsonboolean required
configIdstring uuid required

Identifier of the Feature Flag's Config.

configNamestring required

Name of the Feature Flag's Config.

createdAtstring date-time nullable required

The creation time of the Feature Flag or Setting.