Update Study
Authorizations
Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.
Path Parameters
Body
Update a study (PATCH semantics — only provided fields change).
Study display name
Study-type template slug
"in-depth-interview"panel (recruit from the panel) or byop (bring your own participants)
panel, byop chat, video, or voice
chat, video, voice Interviewer voice: male (Elliot) or female (Clara)
male, female Interview language: an ISO 639-1 code, or 'auto' to auto-detect. Must be one of the supported options.
auto, ar, bg, cs, da, de, el, en, es, fi, fil, fr, hi, hr, id, it, ja, ko, ms, nl, pl, pt, ro, ru, sk, sv, ta, tr, uk, zh Interview instructions as named sections.
Incentive settings (BYOP only).
External pages to show participants in a concept/prototype test. Each item is {url, label}; id is auto-generated.
[
{
"label": "Pricing Page A",
"url": "https://example.com/pricing-a"
},
{
"label": "Pricing Page B",
"url": "https://example.com/pricing-b"
}
]Response
Successful Response
Full study shape returned by get-by-id (includes the heavy fields).
Study-type template slug
panel or byop
chat, video, or voice
chat, video, voice male or female
male, female Interview language code, e.g. 'en'
Response variant — all sections optional (a study's stored prompt may not contain every section).

