v2

latestOpenAPI 3.0.02026-08-073221853.1 MB

Dynamic Configs

Update Dynamic Config Rule By Id

patch/console/v1/dynamic_configs/{id}/rule/{ruleId}

Path parameters

idstring required

Dynamic Config ID

ruleIdstring required

Rule ID

Query parameters

dryRunboolean

Example:true

Skips persisting updates to the entity (used to validate that inputs are correct)

Request body

namestring

The name of this rule.

passPercentagenumber double

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

environmentsstring[] nullable

idstring

The Statsig ID of this rule.

baseIDstring

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

returnValueobject

returnValueJson5string

Response

Update Dynamic Config Rule Response

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "message": "Dynamic Config rules updated successfully.",
  "data": {
    "id": "a_dynamic_config",
    "permalink": "https://console.statsig.com/company_id/dynamic_configs/a_dynamic_config",
    "description": "helpful summary of what this dynamic config does",
    "idType": "userID",
    "creatorEmail": "johnsmith@mydomain.com",
    "creatorName": "John Smith",
    "createdTime": 1674769467002,
    "lastModifierID": "1vaQaBoLlkauH9iiuOSBP2",
    "lastModifierName": "CONSOLE API",
    "lastModifiedTime": 1707344887865,
    "lastModifierEmail": null,
    "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
        },
        "completedAutomatedRollouts": [],
        "pendingAutomatedRollouts": []
      }
    ],
    "defaultValue": {
      "key": "the default value"
    },
    "tags": [
      "a tag"
    ],
    "type": "TEMPORARY",
    "typeReason": "NONE",
    "isPermanent": false
  }
}