Sign in
Gates

Fully Update Gates

post/console/v1/gates/{id}

Path parameters

idstring required

id

Query parameters

includeArchiveMetadata'true' | 'false'

When "true", populate archivedAt / archivedBy* / archiveReason on the gate when it is currently archived. When omitted or "false", those fields are absent from the response.

Request body

namestring

The gate display name

isEnabledboolean required
descriptionstring required
tagsstring[]
type'PERMANENT' | 'TEMPORARY'
idTypestring
creatorIDstring nullable
creatorEmailstring nullable
teamstring nullable
teamIDstring nullable
measureMetricLiftsboolean
releasePipelineIDstring nullable

Example request

{
  "isEnabled": false,
  "description": "Updated Gate Description",
  "rules": [
    {
      "name": "All Conditions",
      "passPercentage": 10,
      "conditions": [
        {
          "type": "user_id",
          "targetValue": [
            "111",
            "222"
          ],
          "operator": "any"
        },
        {
          "type": "email",
          "targetValue": [
            "@outlook.com",
            "@gmail.com"
          ],
          "operator": "str_contains_any"
        },
        {
          "type": "custom_field",
          "targetValue": 31,
          "operator": "gt",
          "field": "age"
        },
        {
          "type": "app_version",
          "targetValue": "1.1.1",
          "operator": "version_gt"
        },
        {
          "type": "browser_name",
          "targetValue": [
            "Android",
            "Chrome"
          ],
          "operator": "any"
        },
        {
          "type": "browser_version",
          "targetValue": [
            "94.0.4606.81",
            "94.0.4606.92"
          ],
          "operator": "any"
        },
        {
          "type": "os_name",
          "targetValue": [
            "Android",
            "Windows"
          ],
          "operator": "none"
        },
        {
          "type": "os_version",
          "targetValue": "11.0.0",
          "operator": "version_lte"
        },
        {
          "type": "country",
          "targetValue": [
            "NZ",
            "US"
          ],
          "operator": "any"
        },
        {
          "type": "environment_tier",
          "targetValue": [
            "production"
          ],
          "operator": "any"
        },
        {
          "type": "passes_segment",
          "targetValue": "growth_org"
        },
        {
          "type": "fails_segment",
          "targetValue": "growth_org"
        },
        {
          "type": "ip_address",
          "targetValue": [
            "1.1.1.1",
            "8.8.8.8"
          ],
          "operator": "any"
        },
        {
          "type": "unit_id",
          "operator": "any",
          "targetValue": [
            "31"
          ],
          "customID": "userID"
        }
      ]
    }
  ],
  "tags": [
    "★ Core"
  ],
  "type": "TEMPORARY",
  "idType": "stableID",
  "targetApps": []
}

Response

Update gate response

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "data": {
    "checksPerHour": 0,
    "createdTime": 1705439406615,
    "creatorEmail": null,
    "creatorID": "4R5PV7mvYdW6NLCwK8ocoz",
    "creatorName": "CONSOLE API",
    "description": "Updated Gate Description",
    "holdoutIDs": [],
    "id": "a_gate",
    "idType": "stableID",
    "isEnabled": false,
    "lastModifiedTime": 1705439409750,
    "lastModifierEmail": null,
    "lastModifierID": "4R5PV7mvYdW6NLCwK8ocoz",
    "lastModifierName": "CONSOLE API",
    "name": "A Gate",
    "rules": [
      {
        "conditions": [
          {
            "operator": "any",
            "targetValue": [
              "111",
              "222"
            ],
            "type": "user_id"
          },
          {
            "operator": "str_contains_any",
            "targetValue": [
              "@outlook.com",
              "@gmail.com"
            ],
            "type": "email"
          },
          {
            "field": "age",
            "operator": "gt",
            "targetValue": 31,
            "type": "custom_field"
          },
          {
            "operator": "version_gt",
            "targetValue": "1.1.1",
            "type": "app_version"
          },
          {
            "operator": "any",
            "targetValue": [
              "Android",
              "Chrome"
            ],
            "type": "browser_name"
          },
          {
            "operator": "any",
            "targetValue": [
              "94.0.4606.81",
              "94.0.4606.92"
            ],
            "type": "browser_version"
          },
          {
            "operator": "none",
            "targetValue": [
              "Android",
              "Windows"
            ],
            "type": "os_name"
          },
          {
            "operator": "version_lte",
            "targetValue": "11.0.0",
            "type": "os_version"
          },
          {
            "operator": "any",
            "targetValue": [
              "NZ",
              "US"
            ],
            "type": "country"
          },
          {
            "operator": "any",
            "targetValue": [
              "production"
            ],
            "type": "environment_tier"
          },
          {
            "targetValue": "growth_org",
            "type": "passes_segment"
          },
          {
            "targetValue": "growth_org",
            "type": "fails_segment"
          },
          {
            "operator": "any",
            "targetValue": [
              "1.1.1.1",
              "8.8.8.8"
            ],
            "type": "ip_address"
          },
          {
            "customID": "userID",
            "operator": "any",
            "targetValue": [
              "31"
            ],
            "type": "unit_id"
          }
        ],
        "environments": null,
        "name": "All Conditions",
        "passPercentage": 10
      }
    ],
    "status": "Disabled",
    "tags": [
      "★ Core"
    ],
    "targetApps": [],
    "type": "PERMANENT",
    "typeReason": "NONE",
    "team": null,
    "reviewSettings": {
      "requiredReview": false,
      "allowedReviewers": []
    },
    "measureMetricLifts": true,
    "store0100Exposures": false,
    "owner": {
      "ownerID": "user123",
      "ownerName": "CONSOLE API",
      "ownerType": "SDK_KEY",
      "ownerEmail": ""
    },
    "monitoringMetrics": [],
    "version": 2,
    "permalink": "https://console.statsig.com/company_id/gates/a_gate"
  },
  "message": "Gate updated successfully."
}

Changes

Changed in 1 of the 8 revisions of this API.12626

  • 1fd471fa03cc12626See the full diff
    • ▲

      request property rules/items/conditions/items/operator was restricted to a list of enum values

      request-property-became-enum

    • ●

      added the new after enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new any enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new any_case_sensitive enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new array_contains_all enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new array_contains_any enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new array_contains_none enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new before enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new encoded_any enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new gt enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new gte enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new is_not_null enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new is_null enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new lt enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new lte enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new none enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new none_case_sensitive enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new not_array_contains_all enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new on enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new str_contains_any enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new str_contains_none enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new str_matches enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new version_eq enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new version_gt enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new version_gte enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new version_lt enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new version_lte enum value to the allOf[subschema #2]/data/rules/items/conditions/items/operator response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new after enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new any enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new any_case_sensitive enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new array_contains_all enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new array_contains_any enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new array_contains_none enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new before enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new encoded_any enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new gt enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new gte enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new is_not_null enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new is_null enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new lt enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new lte enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new none enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new none_case_sensitive enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new not_array_contains_all enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new on enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new str_contains_any enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new str_contains_none enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new str_matches enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new version_eq enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new version_gt enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new version_gte enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new version_lt enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added

    • ○

      added the new version_lte enum value to the request property rules/items/conditions/items/operator

      request-property-enum-value-added