Create holdout

POST /console/v1/holdouts

Create holdout

cURL

curl --request POST \
  --url https://statsigapi.net/console/v1/holdouts \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "name": "team holdout",
  "description": "holdout for this team",
  "idType": "userID",
  "teamID": "4pjeXYDjC2WinSgOiII7wh"
}
'

200

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

Authorizations

STATSIG-API-KEY · string · header · required

Body

application/json

name · string · required

name of the holdout

Required string length: 3 - 100

Pattern: ^[a-zA-Z0-9_\- ]*$

Example:

"team holdout"

description · string

description of the holdout

Maximum string length: 1000

Example:

"holdout for this team"

idType · string

type of id

Example:

"userID"

teamID · string | null

id of the team

Example:

"4pjeXYDjC2WinSgOiII7wh"

Response

200

application/json

Create holdout response

message · string · required

A simple string explaining the result of the operation.

data · object · required

A single result.

Show child attributes