Sign in
Admin Experiments

Force a variant — all reads return this immediately

Use as a kill switch (force the safe variant) or a 100% rollout (force the winning variant).

post/v1/admin/experiments/{key}/force-variant

Path parameters

keystring required

Experiment key

Request body

variantIdstring required

Must be one of the variant ids defined on the experiment. All reads will return this variant immediately.

Response

idstring required
keystring required
namestring required
descriptionstring nullable
status'draft' | 'running' | 'paused' | 'completed' required
enrollmentMode'auto' | 'manual' required
defaultVariantIdstring nullable
forcedVariantIdstring nullable
winnerVariantIdstring nullable
completedAtstring date-time nullable
seedstring required
subjectType'firebase_uid' required
createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this endpoint across all 1 revision of this API.