v2

latestOpenAPI 3.0.02026-08-073221853.1 MB

Holdouts

Create holdout

post/console/v1/holdouts

Request body

namestring required

name of the holdout

descriptionstring

description of the holdout

idTypestring

type of id

teamIDstring nullable

id of the team

Example request

{
  "name": "team holdout",
  "description": "holdout for this team",
  "idType": "userID",
  "teamID": "4pjeXYDjC2WinSgOiII7wh"
}

Response

Create holdout response

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "message": "Holdout created successfully.",
  "data": {
    "id": "a_holdout",
    "permalink": "https://console.statsig.com/company_id/holdouts/a_holdout",
    "name": "a holdout",
    "description": "helpful summary of what this holdout does",
    "idType": "userID",
    "lastModifierID": "1vaQaBoLlkauH9iiuOSBP2",
    "lastModifiedTime": 1707768016211,
    "lastModifierName": "CONSOLE API",
    "lastModifierEmail": null,
    "creatorID": "1vaQaBoLlkauH9iiuOSBP2",
    "createdTime": 1707768015729,
    "creatorName": "CONSOLE API",
    "creatorEmail": null,
    "targetApps": [],
    "tags": [],
    "team": "Console Team",
    "isEnabled": true,
    "isGlobal": false,
    "passPercentage": 0,
    "gateIDs": [],
    "experimentIDs": [],
    "layerIDs": [],
    "targetingGateID": null
  }
}