Dynamic Configs

Update Dynamic Config Rule By Id

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

Request

  • Base URL
    https://statsigapi.net
  • URL
    https://statsigapi.net/console/v1/dynamic_configs/{id}/rule/{ruleId}
  • Auth
    API key in header STATSIG-API-KEY

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": "any",
            "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
  }
}

Changes

    • info

      added the new optional request property //

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      the response optional property //// became not read-only for the status

    • breaking

      request property // was restricted to a list of enum values

    • warning

      added the new after enum value to the ////// response property for the response status

    • warning

      added the new any enum value to the ////// response property for the response status

    • warning

      added the new any_case_sensitive enum value to the ////// response property for the response status

    • warning

      added the new array_contains_all enum value to the ////// response property for the response status

    • warning

      added the new array_contains_any enum value to the ////// response property for the response status

    • warning

      added the new array_contains_none enum value to the ////// response property for the response status

    • warning

      added the new before enum value to the ////// response property for the response status

    • warning

      added the new encoded_any enum value to the ////// response property for the response status

    • warning

      added the new gt enum value to the ////// response property for the response status

    • warning

      added the new gte enum value to the ////// response property for the response status

    • warning

      added the new is_not_null enum value to the ////// response property for the response status

    • warning

      added the new is_null enum value to the ////// response property for the response status

    • warning

      added the new lt enum value to the ////// response property for the response status

    • warning

      added the new lte enum value to the ////// response property for the response status

    • warning

      added the new none enum value to the ////// response property for the response status

    • warning

      added the new none_case_sensitive enum value to the ////// response property for the response status

    • warning

      added the new not_array_contains_all enum value to the ////// response property for the response status

    • warning

      added the new on enum value to the ////// response property for the response status

    • warning

      added the new str_contains_any enum value to the ////// response property for the response status

    • warning

      added the new str_contains_none enum value to the ////// response property for the response status

    • warning

      added the new str_matches enum value to the ////// response property for the response status

    • warning

      added the new version_eq enum value to the ////// response property for the response status

    • warning

      added the new version_gt enum value to the ////// response property for the response status

    • warning

      added the new version_gte enum value to the ////// response property for the response status

    • warning

      added the new version_lt enum value to the ////// response property for the response status

    • warning

      added the new version_lte enum value to the ////// response property for the response status

    • info

      added the new after enum value to the request property //

    • info

      added the new any enum value to the request property //

    • info

      added the new any_case_sensitive enum value to the request property //

    • info

      added the new array_contains_all enum value to the request property //

    • info

      added the new array_contains_any enum value to the request property //

    • info

      added the new array_contains_none enum value to the request property //

    • info

      added the new before enum value to the request property //

    • info

      added the new encoded_any enum value to the request property //

    • info

      added the new gt enum value to the request property //

    • info

      added the new gte enum value to the request property //

    • info

      added the new is_not_null enum value to the request property //

    • info

      added the new is_null enum value to the request property //

    • info

      added the new lt enum value to the request property //

    • info

      added the new lte enum value to the request property //

    • info

      added the new none enum value to the request property //

    • info

      added the new none_case_sensitive enum value to the request property //

    • info

      added the new not_array_contains_all enum value to the request property //

    • info

      added the new on enum value to the request property //

    • info

      added the new str_contains_any enum value to the request property //

    • info

      added the new str_contains_none enum value to the request property //

    • info

      added the new str_matches enum value to the request property //

    • info

      added the new version_eq enum value to the request property //

    • info

      added the new version_gt enum value to the request property //

    • info

      added the new version_gte enum value to the request property //

    • info

      added the new version_lt enum value to the request property //

    • info

      added the new version_lte enum value to the request property //