Sign in

v1

latestOpenAPI 3.1.02026-08-0472428.7 KB
Studies

Replace a draft study

Replace the full configuration of an existing draft study. The same launch flag accepted by POST /v1/studies controls whether this also enqueues the background job: launch=false keeps the study as a draft, launch=true flips it to running and starts execution. Returns 409 if the study has already been launched (status != 'draft'), or if expected_version is provided and another save has bumped the draft's version since it was read.

put/v1/studies/{id}

Path parameters

idstring required

Request body

expected_versioninteger nullable
generate_life_storiesboolean
launchboolean
number_participantsinteger required
persona_contextstring
research_goalstring
titlestring required

Example request

{
  "added_captions": [
    {
      "content": "A new smartphone with a 6.5 inch display...",
      "name": "Product description"
    }
  ],
  "age_parameters": {
    "max_age": 65,
    "min_age": 18
  },
  "assigned_materials": [
    {
      "materials_name": "Control",
      "stimuli": [
        {
          "media": [
            "A new smartphone with a 6.5 inch display..."
          ],
          "stimulus_name": "Product description",
          "stimulus_type": "text"
        }
      ]
    }
  ],
  "number_participants": 50,
  "question_groups": [
    {
      "name": "Purchase Intent",
      "questions": [
        "How likely are you to purchase this product?"
      ],
      "scale": "7 point scale (1 = Not at all likely; 7 = Extremely likely)"
    }
  ],
  "research_goal": "",
  "segments": [
    {
      "name": "Gender",
      "subcategories": [
        {
          "name": "Male",
          "percentage": 50
        },
        {
          "name": "Female",
          "percentage": 50
        }
      ]
    }
  ],
  "title": "Example Study",
  "uploaded_audios": [],
  "uploaded_images": [],
  "uploaded_pdfs": [],
  "uploaded_videos": []
}

Response

OK

job_idstring nullable
study_idstring required
versioninteger nullable