Update Gate Rules

Update all given rules. It does NOT create or delete if you add more rules and remove rules in the rules object.

PATCH /console/v1/gates/{id}/rules/{ruleID}

Update Gate Rules

cURL

curl --request PATCH \
  --url https://statsigapi.net/console/v1/gates/{id}/rules/{ruleID} \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "name": "All Conditions",
  "id": "38ttpCpzrQFTMKcqFKk02l:10.00:1",
  "baseID": "38ttpCpzrQFTMKcqFKk02l",
  "passPercentage": 10,
  "conditions": [
    {
      "type": "user_id",
      "targetValue": [
        "35sClJFs8l0y5uRQhDwUDo"
      ],
      "operator": "any"
    }
  ],
  "environments": [
    "staging"
  ]
}
'

200

{
  "message": "Gate updated successfully.",
  "data": {
    "id": "a_gate",
    "isEnabled": true,
    "description": "helpful summary of what this gate does",
    "status": "In Progress",
    "lastModifierName": "CONSOLE API",
    "lastModifierID": "1vaasdfLlkaujjajiuOSBP2",
    "rules": [
      {
        "name": "All Conditions",
        "id": "38ttpCpzrQFTMKcqFKk02l:10.00:1",
        "baseID": "38ttpCpzrQFTMKcqFKk02l",
        "passPercentage": 10,
        "conditions": [
          {
            "type": "user_id",
            "targetValue": [
              "35sClJFs8l0y5uRQhDwUDo"
            ],
            "operator": "any"
          }
        ],
        "environments": [
          "staging"
        ]
      }
    ],
    "tags": [
      "* Core"
    ]
  }
}

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

Gate ID

ruleID · string · required

Rule ID

Body

application/json

name · string

The name of this rule.

passPercentage · number

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

conditions · object[]

An array of Condition objects.

Show child attributes

environments · string[] | null

The environments this rule is enabled for.

id · string

The Statsig ID of this rule.

baseID · string

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

returnValue · object

The return value of the rule.

Show child attributes

Response

200 - application/json

Update gate response

message · string · required

A simple string explaining the result of the operation.

data · object · required

A single result.

Show child attributes