Skip to main content
PATCH
/
console
/
v1
/
holdouts
/
{id}
Partially update holdout by id
curl --request PATCH \
  --url https://statsigapi.net/console/v1/holdouts/{id} \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "isEnabled": true,
  "description": "example holdout description",
  "passPercentage": 5,
  "gateIDs": [
    "4pjeXYDjC2WinSgOiII7wh"
  ],
  "experimentIDs": [
    "70fCNphHGesdLwHdHau99q"
  ],
  "layerIDs": [
    "5O908pyGoCqw6QH1nt8v82"
  ],
  "isGlobal": false,
  "targetingGateID": "4pjeXYDjC2WinSgOiII7wh",
  "monitoringMetrics": [
    {
      "name": "<string>",
      "type": "<string>"
    }
  ]
}
'
{
  "message": "Holdout updated successfully.",
  "data": {
    "id": "testing_holdout",
    "name": "testing holdout",
    "description": "helpful summary of what the holdout does",
    "idType": "userID",
    "lastModifierID": "4dcQUIpS8PHObBGD7HJwOx",
    "lastModifiedTime": 1719939380702,
    "lastModifierName": "CONSOLE API",
    "lastModifierEmail": null,
    "creatorID": "4dcQUIpS8PHObBGD7HJwOx",
    "createdTime": 1719873870785,
    "creatorName": "CONSOLE API",
    "creatorEmail": null,
    "targetApps": [],
    "tags": [],
    "team": "Console Team",
    "isEnabled": false,
    "isGlobal": false,
    "passPercentage": 0,
    "gateIDs": [],
    "experimentIDs": [],
    "layerIDs": [],
    "targetingGateID": null
  }
}

Authorizations

​
STATSIG-API-KEY
string
header
required

Path Parameters

​
id
string
required

id

Body

application/json
​
isEnabled
boolean

enable or disable the holdout

Example:

true

​
description
string

brief summary of what the holdout is being used for

Maximum string length: 1000
Example:

"example holdout description"

​
passPercentage
number<double>

percentage of users between 0-10% to pass through the holdout

Required range: 0 <= x <= 10
Example:

5

​
gateIDs
string[]

an array of gateIDs which this holdout is applied to

Example:
["4pjeXYDjC2WinSgOiII7wh"]
​
experimentIDs
string[]

an array of experimentIDs which this holdout is applied to

Example:
["70fCNphHGesdLwHdHau99q"]
​
layerIDs
string[]

an array of layerIDs which this holdout is applied to

Example:
["5O908pyGoCqw6QH1nt8v82"]
​
isGlobal
boolean

whether the holdout is being applied to all new gates

Example:

false

​
targetingGateID
string | null

the gateID that the holdout is targeting

Example:

"4pjeXYDjC2WinSgOiII7wh"

​
monitoringMetrics
object[]

Response

Update holdout response

​
message
string
required

A simple string explaining the result of the operation.

​
data
object
required

A single result.