Resume Study
Resume a paused study. A preserved panel survey returns to fielding.
Authorizations
Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.
Headers
Platform admins only: choose an organization for scoped reads and writes. Required to change another organization's study or use its wallet.
128Path Parameters
Response
Successful Response
Full study shape returned by get-by-id (includes the heavy fields).
Current study-type template slug
in-depth-interview, concept-test, prototype-test draft when required interviewer settings are missing, ready when the study can be provisioned, and provisioned when interviews can run
draft, ready, provisioned Recruitment state, separate from interviewer provisioning. Panel studies report their persisted lifecycle. BYOP studies are collecting once the interviewer is provisioned, and can be paused or stopped; invitation delivery is tracked per participant. Synthetic respondents are not_applicable.
not_started, starting, collecting, fielding, paused, complete, partial, failed, stopped, unavailable, not_applicable, unknown 40Historical study-type label when it is outside the current catalog
panel, byop, or synthetic_respondents
panel, byop, synthetic_respondents chat, video, or voice
chat, video, voice male or female
male, female Interview language code, e.g. 'en'
Maximum planned interview duration in seconds, including transitions and likely follow-up probes. This is an estimate, not a guaranteed length.
x >= 300Live participant interview link; null until the interviewer is provisioned. This is not a researcher preview URL.
Researcher management link for the study
Fields still required before the study can be provisioned
Completed visible non-test interviews satisfying quality criteria, matching list_interviews(status=completed).
available, not_generated Response variant — all sections optional (a study's stored prompt may not contain every section).
Human-readable interpretation of the configured panel targeting
Invitation records for this study. A panel launch may use one invitation for many participants.
Interview attempts, including attempts that did not yield a quality interview.
Interviews that passed the study quality criteria.

