Skip to main content
POST
Stop Study

Authorizations

Authorization
string
header
required

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Path Parameters

study_id
string
required

Response

Successful Response

Full study shape returned by get-by-id (includes the heavy fields).

id
string
required
provisioning_status
enum<string>
required

draft when required interviewer settings are missing, ready when the study can be provisioned, and provisioned when interviews can run

Available options:
draft,
ready,
provisioned
name
string | null
Maximum string length: 40
study_type
string | null

Study-type template slug

recruiting_method
string | null

panel or byop

interview_format
enum<string> | null

chat, video, or voice

Available options:
chat,
video,
voice
voice
enum<string> | null

male or female

Available options:
male,
female
language
string | null

Interview language code, e.g. 'en'

expected_duration_seconds
integer
default:900

Maximum planned interview duration in seconds, including transitions and likely follow-up probes. This is an estimate, not a guaranteed length.

Required range: x >= 300
byop_config
PublicByopConfigOut · object

Universal interview link for the study

missing_requirements
string[]

Fields still required before the study can be provisioned

created_at
string<date-time> | null
updated_at
string<date-time> | null
study_plan
PublicStudyPlanOut · object | null

Response variant — all sections optional (a study's stored prompt may not contain every section).

screener_questions
PublicScreenerQuestion · object[] | null
targeting_attributes
PublicTargetingAttribute · object[] | null
total_invites
integer | null

Number of invitation records. For panel studies, a panel launch is one invitation record; individual panel responses are counted in total_calls.

total_calls
integer | null

Number of interviews completed or attempted for the study

quality_calls
integer | null

Number of quality interviews