POST
/
console
/
v1
/
dynamic_configs
/
{id}
Fully Update Dynamic Config
curl --request POST \
  --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": [
        {
          "targetValue": [
            "<string>"
          ],
          "operator": "<string>",
          "field": "<string>",
          "customID": "<string>",
          "type": "app_version"
        }
      ],
      "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": "owner123@test.com"
  },
  "creatorEmail": "<string>",
  "schema": "<string>",
  "schemaJson5": "<string>",
  "targetApps": "<string>",
  "team": "<string>",
  "teamID": "<string>",
  "precommitWebhook": {
    "url": "<string>",
    "internalStatusUrl": "<string>"
  }
}'
{
  "message": "Dynamic config updated successfully.",
  "data": {
    "id": "a_dynamic_config",
    "description": "helpful summary of what this dynamic config does",
    "idType": "userID",
    "lastModifierID": "1vaQaBoLlkauH9iiuOSBP2",
    "lastModifierName": "CONSOLE API",
    "creatorEmail": "johnsmith@mydomain.com",
    "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
required

Is the dynamic config enabled

​
description
string
required

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

Maximum length: 1000
Example:

"helpful summary of what this dynamic config does"

​
rules
object[]
required

An array of Rule objects

​
defaultValue
object

The fallback JSON object when no rules are triggered

​
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 | null

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

Example:
{
  "ownerID": "user123",
  "ownerType": "USER",
  "ownerName": "John Doe",
  "ownerEmail": "owner123@test.com"
}
​
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 | null

Response

Fully Update Dynamic Config Response

​
message
string
required

A simple string explaining the result of the operation.

​
data
object
required

A single result.