Update experiment status

patch

https://api.web2wave.com/api/experiments/{id}

Change the lifecycle status of an experiment. This is the single way to pause, stop,
reactivate, archive, or mark success/fail via the API.

Side effects (same as cabinet):

Transition to Active (2) sets start_at if empty and clears a stale past end_at.
Transition to Success, Fail, Stop, or Archive (4–7) sets end_at if empty.

Cannot revert a non-draft experiment back to Draft (1).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Body Params

status

integer

enum

required

Lifecycle status of an A/B experiment:

1 — Draft — Created but not serving traffic. No new users enrolled.
2 — Active — Running. New users are enrolled and variants are served. Sets start_at on first activation; clears a stale past end_at on reactivation.
3 — Pause — Temporarily halted. No new users enrolled; existing assignments are kept.
4 — Success — Marked as a winning test. Sets end_at when missing. No new users enrolled.
5 — Fail — Marked as a losing test. Sets end_at when missing. No new users enrolled.
6 — Stop — Stopped (no new users). Sets end_at when missing. Differs from Archive — experiment stays in the main list.
7 — Archive — Stopped and archived (cabinet "Stop and move to archive"). Sets end_at when missing.

Allowed:

Headers

api_key

string

required

Responses

404

Experiment not found

422

Validation error or invalid status transition

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Experiment updated