Update an experiment.
Partially update an experiment by ID. Only provided fields are updated. Providing allocations replaces the entire allocations set.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
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.
A human-readable name for the experiment
3 - 255^(?!.*\x00)\S(.*\S)?$A description of the experiment
3 - 1024^(?!.*\x00)\S(.*\S)?$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.
authentication, mfa_enrollment, mfa_challenge, password_reset, passkey_enrollment, all Replaces all traffic allocations. Cannot be modified while the experiment is active.
1Applies 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.
tenant, flag Ramp experiment levels configuration. A strictly-increasing sequence of exposure percentages, each an integer in [0, 100]. Can only be modified on draft experiments.
10 <= x <= 100Target lifecycle status. Transitions the experiment through its lifecycle (draft → active, draft → archived, active → paused, paused → active, active/paused → completed, paused/completed → archived). Activation runs full readiness validation and snapshots the configuration. When combined with field edits, the edits apply first and the transition sees the updated config.
active, paused, completed, archived Response
Experiment successfully updated.
^exp_[A-HJ-NP-Za-km-z1-9]+$percentage, segment Filter by status. Exact match.
draft, active, paused, completed, archived Fields that may be mutated given the experiment's current status. Computed at response time; always current with the API's enforcement logic.
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.
tenant, flag Ramp experiment levels configuration.
Read-only. The active exposure percentage for the current ramp step. Null when no ramp schedule is active.