Skip to main content
PATCH
/
console
/
v1
/
gates
/
{id}
Partially Update Gates
curl --request PATCH \
  --url https://statsigapi.net/console/v1/gates/{id} \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "description": "Updated the description of the gate"
}
'
{
  "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,
    "owner": {
      "ownerID": "user123",
      "ownerName": "CONSOLE API",
      "ownerType": "SDK_KEY",
      "ownerEmail": ""
    },
    "monitoringMetrics": []
  },
  "message": "Gate updated successfully."
}

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

id

Body

application/json
​
name
string

The gate display name

Required string length: 3 - 100
​
isEnabled
boolean
​
description
string
Maximum string length: 1000
​
rules
object[]
​
tags
string[]
​
type
enum<string>
Available options:
PERMANENT,
TEMPORARY
​
idType
string
​
targetApps
​
creatorID
string | null
​
creatorEmail
string | null
​
team
string | null
​
teamID
string | null
​
measureMetricLifts
boolean
​
monitoringMetrics
object[]
​
reviewSettings
object

Whether reviews are required for this gate. If a gate has reviews required due to a project-level or team-level setting, setting this will have no effect.

​
releasePipelineID
string | null

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.