STstatsig
Holdouts

Partially update holdout by id

Changed on

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

patch/console/v1/holdouts/{id}

Request

  • Base URL
    https://statsigapi.net
  • URL
    https://statsigapi.net/console/v1/holdouts/{id}
  • Auth
    API key in header STATSIG-API-KEY

Path parameters

idstring required

id

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. For a three-group holdout, this is the total, between 0-66.6% in steps of 0.2%, split evenly between its status quo and shipped groups

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"
  }
}

Changes

  • 45fe639dceebRevision changes
    • breaking

      the // response property's max was increased from 10.00 to 66.60 for the response status

    • info

      the request property's max was increased from 10.00 to 66.60