Pause an experiment

Pauses a running experiment: every end user sees the control arm, and gets its flag values, until it is started again.

Errors

Status	`type`	`code`	When
409	`conflict`	`experiment_not_running`	Unless it is running.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Experiments

Something wrong or missing on this page? Tell us by email or on Discord.

On this page

Authorization Path parameters Examples Response body Errors More in Experiments

Authorization

AuthorizationBearer <token>

A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.

In: header

Path parameters

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

experimentId*string

The experiment's id, exp_....

Examples

curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/experiments/exp_c6v8b3n5q0w2e7h7d2k9m4x1/pause" \  -H "Authorization: Bearer vh_sk_..."

{  "id": "exp_c6v8b3n5q0w2e7h7d2k9m4x1",  "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",  "name": "Onboarding paywall pricing",  "description": "The monthly-first paywall against the annual-first one after onboarding.",  "hypothesis": "Leading with the annual plan brings more new subscriptions.",  "status": "paused",  "primaryMetricEventName": "$subscription.created",  "secondaryMetricEventNames": [],  "paywallLocationIds": [    "pw_loc_m4x1c6v8b3n5q0w2e7h7d2k9"  ],  "testedFeatureFlagIds": [],  "winningVariantId": null,  "featureFlagId": "ff_k9m4x1c6v8b3n5q0w2e7h7d2",  "isArchived": false,  "startedAt": "2026-03-02T09:00:00.000Z",  "endedAt": null,  "createdAt": "2026-02-27T15:20:00.000Z",  "updatedAt": "2026-03-20T17:45:00.000Z"}

{  "error": {    "type": "invalid_request",    "code": "string",    "message": "string",    "param": "string"  }}

{  "error": {    "type": "unauthenticated",    "code": "invalid_api_key",    "message": "This secret key is not valid."  }}

{  "error": {    "type": "permission_denied",    "code": "permission_denied",    "message": "Insufficient permissions."  }}

{  "error": {    "type": "not_found",    "code": "project_not_found",    "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.",    "param": "projectId"  }}

{  "error": {    "type": "conflict",    "code": "experiment_not_running",    "message": "This experiment is not running."  }}

{  "error": {    "type": "internal",    "code": "internal_error",    "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing."  }}

Pause an experiment

Errors

More in Experiments

Pause an experiment

Errors

More in Experiments

Authorization

Path parameters

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Pause an experiment

Pause an experiment

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`