Partially Update Dynamic Config

PATCH /console/v1/dynamic_configs/{id}

Try it

Partially Update Dynamic Config

cURL

curl --request PATCH \
  --url https://statsigapi.net/console/v1/dynamic_configs/{id} \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "isEnabled": true,
  "description": "helpful summary of what this dynamic config does",
  "rules": [
    {
      "name": "<string>",
      "passPercentage": 50,
      "conditions": [
        {
          "type": "app_version",
          "targetValue": [
            "<string>"
          ],
          "operator": "<string>",
          "field": "<string>",
          "customID": "<string>"
        }
      ],
      "environments": [
        "<string>"
      ],
      "id": "<string>",
      "baseID": "<string>",
      "returnValue": {},
      "returnValueJson5": "<string>"
    }
  ],
  "defaultValue": {},
  "defaultValueJson5": "<string>",
  "idType": "userID",
  "tags": [
    "a tag"
  ],
  "creatorID": "<string>",
  "owner": {
    "ownerID": "user123",
    "ownerType": "USER",
    "ownerName": "John Doe",
    "ownerEmail": "[e-mail]"
  },
  "creatorEmail": "<string>",
  "schema": "<string>",
  "schemaJson5": "<string>",
  "targetApps": "<string>",
  "team": "<string>",
  "teamID": "<string>",
  "precommitWebhook": {
    "url": "<string>",
    "internalStatusUrl": "<string>"
  }
}
'

200

{
  "message": "Dynamic config updated successfully.",
  "data": {
    "id": "a_dynamic_config",
    "description": "helpful summary of what this dynamic config does",
    "lastModifierID": "1vaQaBoLlkauH9iiuOSBP2",
    "lastModifierName": "CONSOLE API",
    "creatorEmail": "[e-mail]",
    "creatorName": "John Smith",
    "createdTime": 1674769467002,
    "holdoutIDs": [],
    "isEnabled": true,
    "rules": [
      {
        "name": "All Conditions",
        "id": "38ttpCpzrQFTMKcqFKk02l:10.00:1",
        "baseID": "38ttpCpzrQFTMKcqFKk02l",
        "passPercentage": 10,
        "conditions": [
          {
            "type": "public",
            "operator": "string",
            "targetValue": 0,
            "field": "string",
            "customID": "string"
          }
        ],
        "returnValue": {
          "key": true
        }
      }
    ],
    "defaultValue": {
      "key": "the default value"
    },
    "tags": [
      "a tag"
    ]
  }
}

Authorizations

STATSIG-API-KEY · string · header · required

Headers

x-respect-review-settings · string

Optional header to respect review settings for mutation endpoints.

Path Parameters

id · string · required

id

Body

application/json

isEnabled · boolean · default: true

Is the dynamic config enabled

description · string

A brief summary of what the dynamic config is being used for

Maximum string length: 1000

Example:

"helpful summary of what this dynamic config does"

rules · object[]

An array of Rule objects

Show child attributes

rules. name · string · required

The name of this rule.

rules. passPercentage · number · required

Of the users that meet the conditions of this rule, what percent should return true.

Required range: 0 <= x <= 100Must be a multiple of 0.01

rules. conditions · object[] · required

An array of Condition objects.

Show child attributes

rules.conditions. type · enum<string> · required

Available options: app_version, browser_name, browser_version, country, custom_field, email, environment_tier, fails_gate, fails_segment, ip_address, locale, os_name, os_version, passes_gate, passes_segment, public, time, unit_id, user_id, url, javascript, device_model, target_app

rules.conditions. targetValue

rules.conditions. operator · string

rules.conditions. field · string | null

rules.conditions. customID · string | null

rules. environments · string[] | null

rules. id · string

The Statsig ID of this rule.

rules. baseID · string

The base ID of this rule, i.e. without any added metadata. Will remain the exact same throughout

rules. returnValue · object

Show child attributes

rules.returnValue. {key} · any

rules. returnValueJson5 · string

defaultValue · object

The fallback JSON object when no rules are triggered

Show child attributes

defaultValue. {key} · any

defaultValueJson5 · string

Can include comments. If provided with defaultValue, must parse to the same JSON

idType · string

The type of ID which the dynamic config is based on.

Example:

"userID"

tags · string[]

The list of tag names attached to the dynamic config

Example:

["a tag"]

creatorID · string | null

owner · object

Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.

Show child attributes

owner. ownerID · string

ID of the owner

Example:

"abc123"

owner. ownerType · string

Type of the owner (e.g., SDK_KEY or USER)

Example:

"USER"

owner. ownerName · string

The name of the owner. This field is optional.

Example:

"John Doe"

owner. ownerEmail · string

The email of the owner. This field is optional.

Example:

{
  "ownerID": "user123",
  "ownerType": "USER",
  "ownerName": "John Doe",
  "ownerEmail": "[e-mail]"
}

creatorEmail · string | null

schema · string | null

A schema using JSON Schema Draft 2020-12 to enforce return values of this dynamic config's rules.

schemaJson5 · string | null

schema except with Json5 comments. Optional and should parse to same json as schema.

targetApps

team · string | null

The team name associated with the dynamic config, Enterprise only.

teamID · string | null

The team ID associated with the dynamic config, Enterprise only.

precommitWebhook · object

Show child attributes

precommitWebhook. url · string · required

precommitWebhook. internalStatusUrl · string · required

Response

200

application/json

Partially Update Dynamic Config Response

message · string · required

A simple string explaining the result of the operation.

data · object · required

A single result.

Show child attributes

data. id · string · required

ID

data. description · string · required

A brief summary of what the dynamic config is being used for

Maximum string length: 1000

Example:

"helpful summary of what this dynamic config does"

data. lastModifierID · string | null · required

ID of the last modifier.

data. lastModifiedTime · number | null · required

Time of the last modification.

data. lastModifierEmail · string | null · required

Email of the last modifier.

data. lastModifierName · string | null · required

Name of the last modifier.

data. createdTime · number · required

Timestamp when the entity was created.

data. creatorName · string | null · required

Name of the creator.

data. isEnabled · boolean · default: true · required

Is the dynamic config enabled

data. rules · object[] · required

An array of Rule objects

Show child attributes

data.rules. name · string · required

The name of this rule.

data.rules. passPercentage · number · required

Of the users that meet the conditions of this rule, what percent should return true.

Required range: 0 <= x <= 100Must be a multiple of 0.01

data.rules. conditions · object[] · required

An array of Condition objects.

Show child attributes

data.rules.conditions. type · enum<string> · required

Available options: app_version, browser_name, browser_version, country, custom_field, email, environment_tier, fails_gate, fails_segment, ip_address, locale, os_name, os_version, passes_gate, passes_segment, public, time, unit_id, user_id, url, javascript, device_model, target_app

data.rules.conditions. targetValue

data.rules.conditions. operator · string

data.rules.conditions. field · string | null

data.rules.conditions. customID · string | null

data.rules. environments · string[] | null

data.rules. id · string

The Statsig ID of this rule.

data.rules. baseID · string

The base ID of this rule, i.e. without any added metadata. Will remain the exact same throughout

data.rules. returnValue · object

Show child attributes

data.rules.returnValue. {key} · any

data.rules. returnValueJson5 · string

data. name · string

Optional name for the configuration.

data. idType · string

The type of ID which the dynamic config is based on.

Example:

"userID"

data. creatorID · string | null

data. creatorEmail · string | null

data. tags · string[]

The list of tag names attached to the dynamic config

Example:

["a tag"]

data. targetApps

data. holdoutIDs · string[]

Holdouts applied to this configuration.

data. team · string | null

The team name associated with the dynamic config, Enterprise only.

data. teamID · string | null

The team ID associated with the dynamic config, Enterprise only.

data. version · number

Version number

data. defaultValue · object

The fallback JSON object when no rules are triggered

Show child attributes

data.defaultValue. {key} · any

data. defaultValueJson5 · string

Can include comments. If provided with defaultValue, must parse to the same JSON

data. owner · object

Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.

Show child attributes

data.owner. ownerID · string

ID of the owner

Example:

"abc123"

data.owner. ownerType · string

Type of the owner (e.g., SDK_KEY or USER)

Example:

"USER"

data.owner. ownerName · string

The name of the owner. This field is optional.

Example:

"John Doe"

data.owner. ownerEmail · string

The email of the owner. This field is optional.

Example:

{
  "ownerID": "user123",
  "ownerType": "USER",
  "ownerName": "John Doe",
  "ownerEmail": "[e-mail]"
}

data. schema · string | null

A schema using JSON Schema Draft 2020-12 to enforce return values of this dynamic config's rules.

data. schemaJson5 · string | null

schema except with Json5 comments. Optional and should parse to same json as schema.

data. precommitWebhook · object

Show child attributes

data.precommitWebhook. url · string · required

data.precommitWebhook. internalStatusUrl · string · required