PATCH
/
console
/
v1
/
holdouts
/
{id}
Patch holdout by id. You can pass in only the data you want to update.
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"
}'
{
  "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

Headers

​
x-respect-review-settings
string

Optional header to respect review settings for mutation endpoints.

Path Parameters

​
id
string
required

id

Body

application/json

Response

200
application/json

Update holdout response

The response is of type object.