Skip to main content
PUT
Updates only the fields you send. config is merged into the stored configuration (existing keys you don’t send are preserved), and config.tutorial is merged switch by switch; all other fields are replaced.
string
required
The study ID.
string
New title.
string
New description.
object
Configuration changes, merged into the existing config. For example, turn on memory with { "enableMemory": true, "memoryFocus": "...", "memoryUsageRules": "..." }; enableMemory must be a boolean, and the two text fields take up to 300 characters each.Participant colors are primaryColor, textColor and backgroundColor, each a 6-digit hex value like #18181B; send an empty textColor or backgroundColor to go back to the default. For a dark look: { "textColor": "#F4F4F5", "backgroundColor": "#18181B" }. A primaryColor sent back unchanged is accepted as stored, even an older value that is not a hex color; a new one that is not a 6-digit hex value returns a 422.uniqueIdentifier, the link parameter that carries your participant ID, must be a single word and can’t be vid; otherwise the request returns 400.Changing mode also moves the study to the standard interview engine, as choosing a mode in the dashboard does: conversational is set to false (send "conversational": true with the new mode to keep the realtime engine), and the previous engine’s voiceEngine and silence setting are cleared.Tutorial page switches go in tutorial: { enabled, requireMicCheck, showMicTest, showTimerColors, showTroubleshooting }, all booleans. Only the switches you send change; for example, { "tutorial": { "enabled": false } } turns the page off and keeps its checks. null counts as false. Unknown switches and any other value return 422. Sending "tutorial": null instead of an object turns every switch off.
object
Replaces the welcome message.
object
Replaces the tutorial page copy: { title, content, ctaText }. Like the other messages it’s replaced whole, so a field you omit reads as the default, not its previous value; send all three to change one. See Copy for the length limits, the HTML that’s kept, and the 422 errors. Saving doesn’t translate the page; call Translate study afterward.
object
Replaces the thank-you message.
object
Replaces the screen-out message.
string
Move the study to a folder.
integer | null
Total-completes cap. null or 0 removes a positive cap. Ignored when the study uses per-link-parameter buckets or is closed with a cap of 0; use Update study quotas to change those.

Response

The updated study object.