Create Study
Create a draft study. Customize its plan before inviting participants or launching recruitment.
Authorizations
Headers
Body
Create a study. Unknown fields, including incentive settings, are rejected.
Interview language: an ISO 639-1 code, or 'auto' to auto-detect. Must be one of the supported options.
auto, af, am, ar, as, az, bg, bn, bs, ca, cs, cy, da, de, el, en, es, et, eu, fa, fi, fil, fr, ga, gl, gu, he, hi, hr, hu, hy, id, is, it, iu, ja, jv, ka, kk, km, kn, ko, lo, lt, lv, mk, ml, mn, mr, ms, mt, my, nb, ne, nl, or, pa, pl, ps, pt, ro, ru, si, sk, sl, so, sq, sr, su, sv, sw, ta, te, th, tr, uk, ur, uz, vi, wuu, yue, zh, zu Response
Successful Response
Full study shape returned by get-by-id (includes the heavy fields).
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 
