v2

latestOpenAPI 3.0.02026-08-073221853.1 MB

Holdouts

Partially update holdout by id

You can pass in only the data you want to update.

patch/console/v1/holdouts/{id}

Path parameters

idstring required

Request body

isEnabledboolean

enable or disable the holdout

descriptionstring

brief summary of what the holdout is being used for

passPercentagenumber double

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

gateIDsstring[]

an array of gate IDs which this holdout is applied to

experimentIDsstring[]

an array of experiment IDs which this holdout is applied to

layerIDsstring[]

an array of layer IDs which this holdout is applied to

isGlobalboolean

whether the holdout is being applied to all new gates

targetingGateIDstring nullable

the ID of the gate that the holdout is targeting; an empty string clears it, null leaves it unchanged

Example request

{
  "isEnabled": true,
  "description": "example holdout description",
  "passPercentage": 5,
  "gateIDs": [
    "my_gate"
  ],
  "experimentIDs": [
    "my_experiment"
  ],
  "layerIDs": [
    "my_layer"
  ],
  "targetingGateID": "my_targeting_gate"
}

Response

Update holdout response

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "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,
    "permalink": "https://console.statsig.com/company_id/holdouts/testing_holdout"
  }
}