Stop Study
Stop panel recruitment and settle/release its active reward hold.
Authorizations
Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.
Path Parameters
Response
Successful Response
Full study shape returned by get-by-id (includes the heavy fields).
draft when required interviewer settings are missing, ready when the study can be provisioned, and provisioned when interviews can run
draft, ready, provisioned 40Study-type template slug
panel or byop
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 >= 300Universal interview link for the study
Fields still required before the study can be provisioned
Response variant — all sections optional (a study's stored prompt may not contain every section).
Number of invitation records. For panel studies, a panel launch is one invitation record; individual panel responses are counted in total_calls.
Number of interviews completed or attempted for the study
Number of quality interviews

