v2

latestOpenAPI 3.0.02026-08-073221853.1 MB

Holdouts

Update holdout by id

post/console/v1/holdouts/{id}

Path parameters

idstring required

Request body

isEnabledboolean required

enable or disable the holdout

descriptionstring required

brief summary of what the holdout is being used for

passPercentagenumber double required

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

gateIDsstring[] required

an array of gate IDs which this holdout is applied to

experimentIDsstring[] required

an array of experiment IDs which this holdout is applied to

layerIDsstring[] required

an array of layer IDs which this holdout is applied to

isGlobalboolean required

whether the holdout is being applied to all new gates

targetingGateIDstring nullable required

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": "UPDATED summary of what this holdout does",
    "idType": "userID",
    "lastModifierID": "4dcQUIpS8PHObBGD7HJwOx",
    "lastModifiedTime": 1719941188286,
    "lastModifierName": "CONSOLE API",
    "lastModifierEmail": null,
    "creatorID": "4dcQUIpS8PHObBGD7HJwOx",
    "createdTime": 1719873870785,
    "creatorName": "CONSOLE API",
    "creatorEmail": null,
    "targetApps": [],
    "tags": [],
    "team": "Console Team",
    "isEnabled": true,
    "isGlobal": true,
    "passPercentage": 5,
    "gateIDs": [],
    "experimentIDs": [
      "testing123"
    ],
    "layerIDs": [],
    "targetingGateID": "",
    "permalink": "https://console.statsig.com/company_id/holdouts/testing_holdout"
  }
}