Skip to main content
POST
Update Experiment

Authorizations

X-EntityToken
string
header
required

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Body

application/json

Given a title entity token and experiment details, this API updates the experiment. If an experiment is already running, only the description and duration properties can be updated.

Given a title entity token and experiment details, this API updates the experiment. If an experiment is already running, only the description and duration properties can be updated.

Id
string
required

Id of the experiment.

Name
string
required

Friendly name of the experiment.

StartDate
string
required

When experiment should start.

Variants
object[]
required

List of variants for the experiment.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Description
string

Description of the experiment.

EndDate
string

When experiment should end.

ExclusionGroupId
string

Id of the exclusion group.

ExclusionGroupTrafficAllocation
number

Percentage of exclusion group traffic that will see this experiment.

ExperimentType
enum<string>

Type of experiment.

Available options:
Active,
Snapshot
SegmentId
string

Id of the segment to which this experiment applies. Defaults to the 'All Players' segment.

TitlePlayerAccountTestIds
string[]

List of title player account IDs that automatically receive treatments in the experiment, but are not included when calculating experiment metrics.

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Last modified on October 1, 2026