Sign in
Experiment

Updates the provided fields of an experiment and returns the full updated document.

Omitted fields are left untouched. Key and salt are never updatable; flags are updatable only while the experiment is a draft — afterwards the response is 409 with code immutable_field.

patch/campaign/experiments/{experimentKey}

Path parameters

experimentKeystring required

The experiment's stable key.

Request body

descriptionstring nullable

Human-readable description of the hypothesis.

treatmentBpsinteger nullable

Treatment share in basis points (0–10000).

endAtstring date-time nullable

End of the experiment window.

Response

OK

idstring required

The unique id of the experiment document.

keystring required

Stable unique identifier; the analysis key is exp:<key>.

descriptionstring required

Human-readable description of the hypothesis.

state'draft' | 'active' | 'paused' | 'completed' required
userEnrollment'perSession' | 'sticky' required
startAtstring date-time nullable

Outside the [startAt, endAt) window the experiment is treated as inactive.

endAtstring date-time nullable

End of the experiment window; the experiment auto-completes afterwards.

createdBystring required

The email of the admin who created the experiment.

createdAtstring date-time required

When the experiment was created.

updatedAtstring date-time required

When the experiment was last changed.

Changes

Changed in 1 of the 7 revisions of this API.1