Skip to main content
PATCH
C#

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The ID of the experiment to update.

Body

Partial update of an experiment. Only provided fields are updated. Providing allocations replaces the entire allocations set.

name
string

A human-readable name for the experiment

Required string length: 3 - 255
Pattern: ^(?!.*\x00)\S(.*\S)?$
description
string | null

A description of the experiment

Required string length: 3 - 1024
Pattern: ^(?!.*\x00)\S(.*\S)?$
authentication_flow
enum<string>

Specifies the target authentication flow for this experiment. This field can only be modified on draft experiments. Must be one of: authentication, mfa_enrollment, mfa_challenge, password_reset, passkey_enrollment, or all. Note that the all value targets every flow at once, but requires that this is the only active experiment.

Available options:
authentication,
mfa_enrollment,
mfa_challenge,
password_reset,
passkey_enrollment,
all
allocations
object[]

Replaces all traffic allocations. Cannot be modified while the experiment is active.

Minimum array length: 1
default_config
enum<string>

Applies only to Auth0-managed flags. Controls where non-overridden config keys resolve from: 'tenant' inherits the tenant's live config, 'flag' uses the flag's frozen defaults. Can only be modified on draft experiments. Rejected for customer-defined flags.

Available options:
tenant,
flag
levels
integer[]

Ramp experiment levels configuration. A strictly-increasing sequence of exposure percentages, each an integer in [0, 100]. Can only be modified on draft experiments.

Minimum array length: 1
Required range: 0 <= x <= 100

Response

Experiment successfully updated.

id
string
required
Pattern: ^exp_[A-HJ-NP-Za-km-z1-9]+$
name
string
required
feature_flag_id
string
required
authentication_flow
string
required
allocation_strategy
enum<string>
required
Available options:
percentage,
segment
status
enum<string>
required

Filter by status. Exact match.

Available options:
draft,
active,
paused,
completed,
archived
is_valid
boolean
required
allocations
object[]
required
editable_fields
string[]
required

Fields that may be mutated given the experiment's current status. Computed at response time; always current with the API's enforcement logic.

created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string
feature_flag_name
string
default_config
enum<string>

For Auth0-managed flags, where non-overridden config keys resolve from: 'tenant' inherits the tenant's live config, 'flag' uses the flag's frozen defaults. Omitted when unset (defaults to 'tenant' at resolution). Not applicable to customer-defined flags.

Available options:
tenant,
flag
feature_flag_snapshot
object | null
levels
integer[]

Ramp experiment levels configuration.

current_level
integer | null

Read-only. The active exposure percentage for the current ramp step. Null when no ramp schedule is active.

started_at
string<date-time>
ended_at
string<date-time>