Patch Study

PATCH

api

public

studies

{study_id}

Patch Study

curl --request PATCH \
  --url https://api.userintuition.ai/api/public/v1/studies/{study_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "study_type": "in-depth-interview",
  "study_plan": {
    "objectives": "<string>",
    "conversation_flow": "<string>",
    "background": "<string>",
    "learning_goals": "<string>",
    "key_questions": "<string>",
    "study_specific_rules": "<string>"
  },
  "expected_duration_seconds": 301,
  "screener_questions": [
    {
      "options": [
        {
          "selection_rule": "must_select",
          "text": "Required tool"
        },
        {
          "selection_rule": "may_select",
          "text": "Optional tool"
        },
        {
          "selection_rule": "reject",
          "text": "Disqualifying tool"
        }
      ],
      "text": "Which tools do you use?",
      "type": "multi_select"
    }
  ],
  "targeting_attributes": [
    {
      "qualification_id": 123,
      "allowed_options": [
        123
      ],
      "disallowed_options": [
        123
      ]
    }
  ],
  "byop_config": {
    "incentive_amount": 203,
    "is_incentives_enabled": true,
    "auto_send_incentives": true
  }
}
'

import requests

url = "https://api.userintuition.ai/api/public/v1/studies/{study_id}"

payload = {
    "name": "<string>",
    "study_type": "in-depth-interview",
    "study_plan": {
        "objectives": "<string>",
        "conversation_flow": "<string>",
        "background": "<string>",
        "learning_goals": "<string>",
        "key_questions": "<string>",
        "study_specific_rules": "<string>"
    },
    "expected_duration_seconds": 301,
    "screener_questions": [
        {
            "options": [
                {
                    "selection_rule": "must_select",
                    "text": "Required tool"
                },
                {
                    "selection_rule": "may_select",
                    "text": "Optional tool"
                },
                {
                    "selection_rule": "reject",
                    "text": "Disqualifying tool"
                }
            ],
            "text": "Which tools do you use?",
            "type": "multi_select"
        }
    ],
    "targeting_attributes": [
        {
            "qualification_id": 123,
            "allowed_options": [123],
            "disallowed_options": [123]
        }
    ],
    "byop_config": {
        "incentive_amount": 203,
        "is_incentives_enabled": True,
        "auto_send_incentives": True
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    study_type: 'in-depth-interview',
    study_plan: {
      objectives: '<string>',
      conversation_flow: '<string>',
      background: '<string>',
      learning_goals: '<string>',
      key_questions: '<string>',
      study_specific_rules: '<string>'
    },
    expected_duration_seconds: 301,
    screener_questions: [
      {
        options: [
          {selection_rule: 'must_select', text: 'Required tool'},
          {selection_rule: 'may_select', text: 'Optional tool'},
          {selection_rule: 'reject', text: 'Disqualifying tool'}
        ],
        text: 'Which tools do you use?',
        type: 'multi_select'
      }
    ],
    targeting_attributes: [{qualification_id: 123, allowed_options: [123], disallowed_options: [123]}],
    byop_config: {incentive_amount: 203, is_incentives_enabled: true, auto_send_incentives: true}
  })
};

fetch('https://api.userintuition.ai/api/public/v1/studies/{study_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.userintuition.ai/api/public/v1/studies/{study_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'study_type' => 'in-depth-interview',
    'study_plan' => [
        'objectives' => '<string>',
        'conversation_flow' => '<string>',
        'background' => '<string>',
        'learning_goals' => '<string>',
        'key_questions' => '<string>',
        'study_specific_rules' => '<string>'
    ],
    'expected_duration_seconds' => 301,
    'screener_questions' => [
        [
                'options' => [
                                [
                                                                'selection_rule' => 'must_select',
                                                                'text' => 'Required tool'
                                ],
                                [
                                                                'selection_rule' => 'may_select',
                                                                'text' => 'Optional tool'
                                ],
                                [
                                                                'selection_rule' => 'reject',
                                                                'text' => 'Disqualifying tool'
                                ]
                ],
                'text' => 'Which tools do you use?',
                'type' => 'multi_select'
        ]
    ],
    'targeting_attributes' => [
        [
                'qualification_id' => 123,
                'allowed_options' => [
                                123
                ],
                'disallowed_options' => [
                                123
                ]
        ]
    ],
    'byop_config' => [
        'incentive_amount' => 203,
        'is_incentives_enabled' => true,
        'auto_send_incentives' => true
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.userintuition.ai/api/public/v1/studies/{study_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"study_type\": \"in-depth-interview\",\n  \"study_plan\": {\n    \"objectives\": \"<string>\",\n    \"conversation_flow\": \"<string>\",\n    \"background\": \"<string>\",\n    \"learning_goals\": \"<string>\",\n    \"key_questions\": \"<string>\",\n    \"study_specific_rules\": \"<string>\"\n  },\n  \"expected_duration_seconds\": 301,\n  \"screener_questions\": [\n    {\n      \"options\": [\n        {\n          \"selection_rule\": \"must_select\",\n          \"text\": \"Required tool\"\n        },\n        {\n          \"selection_rule\": \"may_select\",\n          \"text\": \"Optional tool\"\n        },\n        {\n          \"selection_rule\": \"reject\",\n          \"text\": \"Disqualifying tool\"\n        }\n      ],\n      \"text\": \"Which tools do you use?\",\n      \"type\": \"multi_select\"\n    }\n  ],\n  \"targeting_attributes\": [\n    {\n      \"qualification_id\": 123,\n      \"allowed_options\": [\n        123\n      ],\n      \"disallowed_options\": [\n        123\n      ]\n    }\n  ],\n  \"byop_config\": {\n    \"incentive_amount\": 203,\n    \"is_incentives_enabled\": true,\n    \"auto_send_incentives\": true\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.userintuition.ai/api/public/v1/studies/{study_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"study_type\": \"in-depth-interview\",\n  \"study_plan\": {\n    \"objectives\": \"<string>\",\n    \"conversation_flow\": \"<string>\",\n    \"background\": \"<string>\",\n    \"learning_goals\": \"<string>\",\n    \"key_questions\": \"<string>\",\n    \"study_specific_rules\": \"<string>\"\n  },\n  \"expected_duration_seconds\": 301,\n  \"screener_questions\": [\n    {\n      \"options\": [\n        {\n          \"selection_rule\": \"must_select\",\n          \"text\": \"Required tool\"\n        },\n        {\n          \"selection_rule\": \"may_select\",\n          \"text\": \"Optional tool\"\n        },\n        {\n          \"selection_rule\": \"reject\",\n          \"text\": \"Disqualifying tool\"\n        }\n      ],\n      \"text\": \"Which tools do you use?\",\n      \"type\": \"multi_select\"\n    }\n  ],\n  \"targeting_attributes\": [\n    {\n      \"qualification_id\": 123,\n      \"allowed_options\": [\n        123\n      ],\n      \"disallowed_options\": [\n        123\n      ]\n    }\n  ],\n  \"byop_config\": {\n    \"incentive_amount\": 203,\n    \"is_incentives_enabled\": true,\n    \"auto_send_incentives\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.userintuition.ai/api/public/v1/studies/{study_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"study_type\": \"in-depth-interview\",\n  \"study_plan\": {\n    \"objectives\": \"<string>\",\n    \"conversation_flow\": \"<string>\",\n    \"background\": \"<string>\",\n    \"learning_goals\": \"<string>\",\n    \"key_questions\": \"<string>\",\n    \"study_specific_rules\": \"<string>\"\n  },\n  \"expected_duration_seconds\": 301,\n  \"screener_questions\": [\n    {\n      \"options\": [\n        {\n          \"selection_rule\": \"must_select\",\n          \"text\": \"Required tool\"\n        },\n        {\n          \"selection_rule\": \"may_select\",\n          \"text\": \"Optional tool\"\n        },\n        {\n          \"selection_rule\": \"reject\",\n          \"text\": \"Disqualifying tool\"\n        }\n      ],\n      \"text\": \"Which tools do you use?\",\n      \"type\": \"multi_select\"\n    }\n  ],\n  \"targeting_attributes\": [\n    {\n      \"qualification_id\": 123,\n      \"allowed_options\": [\n        123\n      ],\n      \"disallowed_options\": [\n        123\n      ]\n    }\n  ],\n  \"byop_config\": {\n    \"incentive_amount\": 203,\n    \"is_incentives_enabled\": true,\n    \"auto_send_incentives\": true\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "provisioning_status": "draft",
  "name": "<string>",
  "study_type": "<string>",
  "recruiting_method": "<string>",
  "interview_format": "chat",
  "voice": "male",
  "language": "<string>",
  "expected_duration_seconds": 900,
  "byop_config": {
    "incentive_amount": 123,
    "is_incentives_enabled": true,
    "auto_send_incentives": true
  },
  "study_link": "<string>",
  "missing_requirements": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "study_plan": {
    "objectives": "<string>",
    "conversation_flow": "<string>",
    "background": "<string>",
    "learning_goals": "<string>",
    "key_questions": "<string>",
    "study_specific_rules": "<string>"
  },
  "screener_questions": [
    {
      "id": "<string>",
      "text": "<string>",
      "type": "single_select",
      "order": 123,
      "options": [
        {
          "id": "<string>",
          "text": "<string>",
          "disqualify": true,
          "selection_rule": "must_select"
        }
      ],
      "input_mode": "integers_only",
      "numeric_ranges": [
        {
          "min": 1,
          "max": 1
        }
      ]
    }
  ],
  "targeting_attributes": [
    {
      "qualification_id": 123,
      "allowed_options": [
        123
      ],
      "disallowed_options": [
        123
      ]
    }
  ],
  "total_invites": 123,
  "total_calls": 123,
  "quality_calls": 123
}

{
  "detail": {
    "code": "active_panel_must_be_paused_or_stopped",
    "message": "<string>",
    "actions": {
      "pause": {
        "method": "POST",
        "endpoint": "<string>",
        "documentation_url": "<string>"
      },
      "stop": {
        "method": "POST",
        "endpoint": "<string>",
        "documentation_url": "<string>"
      }
    }
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

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

Body

application/json

Update a study (PATCH semantics — only provided fields change).

name

string | null

Study display name (maximum 40 characters)

Maximum string length: 40

study_type

string

default:in-depth-interview

Study-type template slug

Allowed value: "in-depth-interview"

recruiting_method

enum<string> | null

panel (recruit from the panel) or byop (bring your own participants)

Available options:

panel,

byop

interview_format

enum<string> | null

chat, video, or voice

Available options:

chat,

video,

voice

voice

enum<string> | null

Interviewer voice: male (Elliot) or female (Clara)

Available options:

male,

female

language

enum<string>

Interview language: an ISO 639-1 code, or 'auto' to auto-detect. Must be one of the supported options.

Available 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

study_plan

PublicStudyPlan · object | null

Interview instructions as named sections.

Show child attributes

expected_duration_seconds

integer | null

Maximum planned interview duration in seconds, including all sections, transitions, and likely follow-up probes. Estimate this from the completed study plan; it is not a guaranteed participant completion time.

Required range: x >= 300

screener_questions

PublicScreenerQuestionInput · object[] | null

Show child attributes

targeting_attributes

PublicTargetingAttribute · object[] | null

Target the panel by demographic qualifications (panel studies).

Show child attributes

byop_config

PublicByopConfig · object | null

Incentive settings (BYOP only).

Show child attributes

Response

Successful Response

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

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

Show child attributes

study_link

string | null

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).

Show child attributes

screener_questions

PublicScreenerQuestion · object[] | null

Show child attributes

targeting_attributes

PublicTargetingAttribute · object[] | null

Show child attributes

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

Patch Study

curl --request PATCH \
  --url https://api.userintuition.ai/api/public/v1/studies/{study_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "study_type": "in-depth-interview",
  "study_plan": {
    "objectives": "<string>",
    "conversation_flow": "<string>",
    "background": "<string>",
    "learning_goals": "<string>",
    "key_questions": "<string>",
    "study_specific_rules": "<string>"
  },
  "expected_duration_seconds": 301,
  "screener_questions": [
    {
      "options": [
        {
          "selection_rule": "must_select",
          "text": "Required tool"
        },
        {
          "selection_rule": "may_select",
          "text": "Optional tool"
        },
        {
          "selection_rule": "reject",
          "text": "Disqualifying tool"
        }
      ],
      "text": "Which tools do you use?",
      "type": "multi_select"
    }
  ],
  "targeting_attributes": [
    {
      "qualification_id": 123,
      "allowed_options": [
        123
      ],
      "disallowed_options": [
        123
      ]
    }
  ],
  "byop_config": {
    "incentive_amount": 203,
    "is_incentives_enabled": true,
    "auto_send_incentives": true
  }
}
'

import requests

url = "https://api.userintuition.ai/api/public/v1/studies/{study_id}"

payload = {
    "name": "<string>",
    "study_type": "in-depth-interview",
    "study_plan": {
        "objectives": "<string>",
        "conversation_flow": "<string>",
        "background": "<string>",
        "learning_goals": "<string>",
        "key_questions": "<string>",
        "study_specific_rules": "<string>"
    },
    "expected_duration_seconds": 301,
    "screener_questions": [
        {
            "options": [
                {
                    "selection_rule": "must_select",
                    "text": "Required tool"
                },
                {
                    "selection_rule": "may_select",
                    "text": "Optional tool"
                },
                {
                    "selection_rule": "reject",
                    "text": "Disqualifying tool"
                }
            ],
            "text": "Which tools do you use?",
            "type": "multi_select"
        }
    ],
    "targeting_attributes": [
        {
            "qualification_id": 123,
            "allowed_options": [123],
            "disallowed_options": [123]
        }
    ],
    "byop_config": {
        "incentive_amount": 203,
        "is_incentives_enabled": True,
        "auto_send_incentives": True
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    study_type: 'in-depth-interview',
    study_plan: {
      objectives: '<string>',
      conversation_flow: '<string>',
      background: '<string>',
      learning_goals: '<string>',
      key_questions: '<string>',
      study_specific_rules: '<string>'
    },
    expected_duration_seconds: 301,
    screener_questions: [
      {
        options: [
          {selection_rule: 'must_select', text: 'Required tool'},
          {selection_rule: 'may_select', text: 'Optional tool'},
          {selection_rule: 'reject', text: 'Disqualifying tool'}
        ],
        text: 'Which tools do you use?',
        type: 'multi_select'
      }
    ],
    targeting_attributes: [{qualification_id: 123, allowed_options: [123], disallowed_options: [123]}],
    byop_config: {incentive_amount: 203, is_incentives_enabled: true, auto_send_incentives: true}
  })
};

fetch('https://api.userintuition.ai/api/public/v1/studies/{study_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.userintuition.ai/api/public/v1/studies/{study_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'study_type' => 'in-depth-interview',
    'study_plan' => [
        'objectives' => '<string>',
        'conversation_flow' => '<string>',
        'background' => '<string>',
        'learning_goals' => '<string>',
        'key_questions' => '<string>',
        'study_specific_rules' => '<string>'
    ],
    'expected_duration_seconds' => 301,
    'screener_questions' => [
        [
                'options' => [
                                [
                                                                'selection_rule' => 'must_select',
                                                                'text' => 'Required tool'
                                ],
                                [
                                                                'selection_rule' => 'may_select',
                                                                'text' => 'Optional tool'
                                ],
                                [
                                                                'selection_rule' => 'reject',
                                                                'text' => 'Disqualifying tool'
                                ]
                ],
                'text' => 'Which tools do you use?',
                'type' => 'multi_select'
        ]
    ],
    'targeting_attributes' => [
        [
                'qualification_id' => 123,
                'allowed_options' => [
                                123
                ],
                'disallowed_options' => [
                                123
                ]
        ]
    ],
    'byop_config' => [
        'incentive_amount' => 203,
        'is_incentives_enabled' => true,
        'auto_send_incentives' => true
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.userintuition.ai/api/public/v1/studies/{study_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"study_type\": \"in-depth-interview\",\n  \"study_plan\": {\n    \"objectives\": \"<string>\",\n    \"conversation_flow\": \"<string>\",\n    \"background\": \"<string>\",\n    \"learning_goals\": \"<string>\",\n    \"key_questions\": \"<string>\",\n    \"study_specific_rules\": \"<string>\"\n  },\n  \"expected_duration_seconds\": 301,\n  \"screener_questions\": [\n    {\n      \"options\": [\n        {\n          \"selection_rule\": \"must_select\",\n          \"text\": \"Required tool\"\n        },\n        {\n          \"selection_rule\": \"may_select\",\n          \"text\": \"Optional tool\"\n        },\n        {\n          \"selection_rule\": \"reject\",\n          \"text\": \"Disqualifying tool\"\n        }\n      ],\n      \"text\": \"Which tools do you use?\",\n      \"type\": \"multi_select\"\n    }\n  ],\n  \"targeting_attributes\": [\n    {\n      \"qualification_id\": 123,\n      \"allowed_options\": [\n        123\n      ],\n      \"disallowed_options\": [\n        123\n      ]\n    }\n  ],\n  \"byop_config\": {\n    \"incentive_amount\": 203,\n    \"is_incentives_enabled\": true,\n    \"auto_send_incentives\": true\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.userintuition.ai/api/public/v1/studies/{study_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"study_type\": \"in-depth-interview\",\n  \"study_plan\": {\n    \"objectives\": \"<string>\",\n    \"conversation_flow\": \"<string>\",\n    \"background\": \"<string>\",\n    \"learning_goals\": \"<string>\",\n    \"key_questions\": \"<string>\",\n    \"study_specific_rules\": \"<string>\"\n  },\n  \"expected_duration_seconds\": 301,\n  \"screener_questions\": [\n    {\n      \"options\": [\n        {\n          \"selection_rule\": \"must_select\",\n          \"text\": \"Required tool\"\n        },\n        {\n          \"selection_rule\": \"may_select\",\n          \"text\": \"Optional tool\"\n        },\n        {\n          \"selection_rule\": \"reject\",\n          \"text\": \"Disqualifying tool\"\n        }\n      ],\n      \"text\": \"Which tools do you use?\",\n      \"type\": \"multi_select\"\n    }\n  ],\n  \"targeting_attributes\": [\n    {\n      \"qualification_id\": 123,\n      \"allowed_options\": [\n        123\n      ],\n      \"disallowed_options\": [\n        123\n      ]\n    }\n  ],\n  \"byop_config\": {\n    \"incentive_amount\": 203,\n    \"is_incentives_enabled\": true,\n    \"auto_send_incentives\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.userintuition.ai/api/public/v1/studies/{study_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"study_type\": \"in-depth-interview\",\n  \"study_plan\": {\n    \"objectives\": \"<string>\",\n    \"conversation_flow\": \"<string>\",\n    \"background\": \"<string>\",\n    \"learning_goals\": \"<string>\",\n    \"key_questions\": \"<string>\",\n    \"study_specific_rules\": \"<string>\"\n  },\n  \"expected_duration_seconds\": 301,\n  \"screener_questions\": [\n    {\n      \"options\": [\n        {\n          \"selection_rule\": \"must_select\",\n          \"text\": \"Required tool\"\n        },\n        {\n          \"selection_rule\": \"may_select\",\n          \"text\": \"Optional tool\"\n        },\n        {\n          \"selection_rule\": \"reject\",\n          \"text\": \"Disqualifying tool\"\n        }\n      ],\n      \"text\": \"Which tools do you use?\",\n      \"type\": \"multi_select\"\n    }\n  ],\n  \"targeting_attributes\": [\n    {\n      \"qualification_id\": 123,\n      \"allowed_options\": [\n        123\n      ],\n      \"disallowed_options\": [\n        123\n      ]\n    }\n  ],\n  \"byop_config\": {\n    \"incentive_amount\": 203,\n    \"is_incentives_enabled\": true,\n    \"auto_send_incentives\": true\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "provisioning_status": "draft",
  "name": "<string>",
  "study_type": "<string>",
  "recruiting_method": "<string>",
  "interview_format": "chat",
  "voice": "male",
  "language": "<string>",
  "expected_duration_seconds": 900,
  "byop_config": {
    "incentive_amount": 123,
    "is_incentives_enabled": true,
    "auto_send_incentives": true
  },
  "study_link": "<string>",
  "missing_requirements": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "study_plan": {
    "objectives": "<string>",
    "conversation_flow": "<string>",
    "background": "<string>",
    "learning_goals": "<string>",
    "key_questions": "<string>",
    "study_specific_rules": "<string>"
  },
  "screener_questions": [
    {
      "id": "<string>",
      "text": "<string>",
      "type": "single_select",
      "order": 123,
      "options": [
        {
          "id": "<string>",
          "text": "<string>",
          "disqualify": true,
          "selection_rule": "must_select"
        }
      ],
      "input_mode": "integers_only",
      "numeric_ranges": [
        {
          "min": 1,
          "max": 1
        }
      ]
    }
  ],
  "targeting_attributes": [
    {
      "qualification_id": 123,
      "allowed_options": [
        123
      ],
      "disallowed_options": [
        123
      ]
    }
  ],
  "total_invites": 123,
  "total_calls": 123,
  "quality_calls": 123
}

{
  "detail": {
    "code": "active_panel_must_be_paused_or_stopped",
    "message": "<string>",
    "actions": {
      "pause": {
        "method": "POST",
        "endpoint": "<string>",
        "documentation_url": "<string>"
      },
      "stop": {
        "method": "POST",
        "endpoint": "<string>",
        "documentation_url": "<string>"
      }
    }
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Overview

Studies

Interviews

Participants

Reports

Targeting

Panels

Feasibility

Study Management

Webhooks

Authorizations

Path Parameters

Body

Response