Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

If using Bearer auth, pass the Secret Key as the token:

Path Parameters

id
string
required

Body

application/json
name
string
Minimum string length: 1
description
string
Maximum string length: 10000
projects
string[]
owner
string

The userId or email address of the owner. If an email address is provided, it will be used to look up the userId of the matching organization member. If an ID is provided, it will be validated as existing in the organization.

tags
string[]
archived
boolean
skipAsDefaultHoldout
boolean

When true, this Holdout is not selected automatically when creating Feature Flags or Experiments in Projects assigned to the Holdout.

holdoutSize
number

Proportion of traffic placed in the holdout group (e.g. 0.05 for 5%). An equally sized comparison group is sampled from the remaining traffic for measurement, so 2× this value enters the holdout experiment in total. Must be greater than 0 and at most 0.5.

Required range: x <= 0.5
hashAttribute
string
targetingCondition
string
savedGroupTargeting
object[]
datasourceId
string
assignmentQueryId
string
goalMetrics
string[]
secondaryMetrics
string[]
statsEngine
enum<string>

Statistics engine used to analyze this Holdout.

Available options:
bayesian,
frequentist
environments
object

Replaces the entire per-environment state. Environments not listed are disabled.

statusUpdateSchedule
object | null

Automatic stage transitions for the Holdout. Dates must be consecutive: startAt before startAnalysisPeriodAt before stopAt. Send null to delete the schedule.

Response

200 - application/json

Resource updated

holdout
object
required