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)?$The authentication flow this experiment applies to. Can only be modified on draft experiments. Must be one of: authentication, mfa_enrollment, mfa_challenge, password_reset, passkey_enrollment, organization_selection, email_verification.
authentication, mfa_enrollment, mfa_challenge, password_reset, passkey_enrollment, organization_selection, email_verification Configuration for how users are assigned to variations
Replaces all traffic allocations. Cannot be modified while the experiment is active.
1Ramp experiment levels configuration. Can only be modified on draft experiments.
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.
Ramp experiment levels configuration.