Gates

Partially Update Gates

patch/console/v1/gates/{id}

Path parameters

idstring required

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

descriptionstring

tagsstring[]

type'PERMANENT' | 'TEMPORARY'

idTypestring

creatorIDstring nullable

creatorEmailstring nullable

teamstring nullable

teamIDstring nullable

measureMetricLiftsboolean

releasePipelineIDstring nullable

Example request

{
  "description": "Updated the description of the gate"
}

Response

Update gate response

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "data": {
    "checksPerHour": 0,
    "createdTime": 1705439406750,
    "creatorEmail": null,
    "creatorID": "4R5PV7mvYdW6NLCwK8ocoz",
    "creatorName": "CONSOLE API",
    "description": "Updated the description of the gate",
    "holdoutIDs": [],
    "id": "a_gate",
    "idType": "userID",
    "isEnabled": true,
    "lastModifiedTime": 1705439498468,
    "lastModifierEmail": null,
    "lastModifierID": "4R5PV7mvYdW6NLCwK8ocoz",
    "lastModifierName": "CONSOLE API",
    "name": "A Gate",
    "rules": [],
    "status": "In Progress",
    "tags": [],
    "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

Aug 26, 20261fd471fa03cc12626See 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

Full history