v2

latestOpenAPI 3.0.02026-08-073221853.1 MB

Gates

Delete Gate Rule

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

Path parameters

idstring required

Gate ID

ruleIDstring required

Rule 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.

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."
}