Sign in

v1

latestOpenAPI 3.0.42026-07-13107171473.3 KB
Feature Flags & Settings

Replace Flag

This endpoint replaces the whole value of a Feature Flag or Setting identified by the settingId parameter.

Important: As this endpoint is doing a complete replace, it's important to set every other attribute that you don't want to change in its original state. Not listing one means it will reset.

put/v1/settings/{settingId}

Path parameters

settingIdinteger required

The identifier of the Setting.

Request body

namestring required

The name of the Feature Flag or Setting.

hintstring nullable

A short description for the setting, shown on the Dashboard UI.

tagsinteger[] nullable

The IDs of the tags which are attached to the setting.

orderinteger nullable

The order of the Setting represented on the ConfigCat Dashboard. Determined from an ascending sequence of integers.

isJsonboolean nullable

Indicates whether this setting should validate string values as JSON values.

Response

When the replace 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.