Skip to main content
Panel studies that are currently fielding must be paused or stopped before you edit them with PUT /studies/{study_id} or PATCH /studies/{study_id}.

​
Draft and provisioned states

Creating a study does not require every launch setting. A partial study is returned with provisioning_status: "draft" and a missing_requirements array. Study names may contain at most 40 characters. Once the name, study plan, voice, and language are present, saving the study automatically provisions its interviewer. A successful response then returns provisioning_status: "provisioned". Do not create participants or launch panel recruitment before that state. If a complete study returns provisioning_status: "ready", it is configured but not yet provisioned. Retry a PATCH with its current complete settings. Launch endpoints return 409 Conflict with code: "study_not_provisioned" until provisioning succeeds.

​
Pause a study

Pausing temporarily stops new responses. For panel studies, the existing panel, recruitment progress, target cycle, and reward authorization hold are preserved. Resume the study to continue the same panel.

​
Resume a study

Resuming returns the preserved panel survey to fielding. It does not create a replacement panel or a second reward hold.

​
Stop a study

Stopping ends active or paused panel recruitment, closes the panel’s target cycle, and settles the reward hold. Any unused authorization is released. Stopping is the appropriate choice when you do not intend to continue the current panel.

​
Editing an active panel

An edit request for a fielding panel returns 409 Conflict:
After either action succeeds, retry the original edit request.