Sign in
Studies

Unpublish an environment

Takes the study down. Deliberately NOT behind the beta gate that guards publishing: an organization that loses the flag must still be able to take a live study down.

Unpublishing something already unpublished answers 200 with deleted: false — a no-op, not an error.

An environment may back more than one study. studyId names which one to take down; the pre-rename scenarioId is still read, so a caller holding that spelling does not need a lookup to migrate. Omitting it is the whole contract while the environment backs a single study, and is refused rather than guessed at once it backs several.

delete/projects/{projectId}/environments/{environmentId}/study

Query parameters

studyIdstring

Which study on this environment to unpublish. Omit while the environment backs a single study; required once it backs more than one, because the server refuses to pick between them.

scenarioIdstring

Pre-rename spelling of studyId, still read here so a caller holding that id does not need a lookup to migrate. Sending both is not an error — studyId wins, and the two cannot disagree about which row they name.

Response

The study was removed (or there was none).

environmentIdstring required
deletedboolean required

False when the environment had no study. NOT an error — unpublishing something already unpublished is a no-op.

idstring

Changes

Changed in 2 of the 122 revisions of this API.2