Skip to main content
PATCH
/
api
/
public
/
v1
/
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>"
  },
  "screener_questions": [
    {
      "text": "<string>",
      "type": "single_select",
      "options": [
        {
          "text": "<string>",
          "disqualify": false,
          "id": "<string>"
        }
      ],
      "order": 123,
      "id": "<string>",
      "text_values": [
        "<string>"
      ],
      "disallowed_text_values": [
        "<string>"
      ],
      "category": "<string>"
    }
  ],
  "targeting_attributes": [
    {
      "qualification_id": 123,
      "allowed_options": [
        123
      ],
      "disallowed_options": [
        123
      ]
    }
  ],
  "byop_config": {
    "incentive_amount": 203,
    "is_incentives_enabled": true,
    "auto_send_incentives": true
  }
}
'
{
  "id": "<string>",
  "name": "<string>",
  "study_type": "<string>",
  "recruiting_method": "<string>",
  "language": "<string>",
  "byop_config": {
    "incentive_amount": 123,
    "is_incentives_enabled": true,
    "auto_send_incentives": true
  },
  "study_link": "<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": "<string>",
      "order": 123,
      "options": [
        {
          "id": "<string>",
          "text": "<string>",
          "disqualify": true
        }
      ],
      "text_values": [
        "<string>"
      ],
      "disallowed_text_values": [
        "<string>"
      ],
      "category": "<string>"
    }
  ],
  "targeting_attributes": [
    {
      "qualification_id": 123,
      "allowed_options": [
        123
      ],
      "disallowed_options": [
        123
      ]
    }
  ],
  "total_invites": 123,
  "total_calls": 123,
  "excellent_calls": 123
}

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

​
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,
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
​
study_plan
PublicStudyPlan · object

Interview instructions as named sections.

​
screener_questions
PublicScreenerQuestionInput · object[] | null
​
targeting_attributes
PublicTargetingAttribute · object[] | null

Target the panel by demographic qualifications (panel studies).

​
byop_config
PublicByopConfig · object

Incentive settings (BYOP only).

Response

Successful Response

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

​
id
string
required
​
name
string | null
​
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'

​
byop_config
PublicByopConfigOut · object
​
study_link
string | null

Universal interview link for the study

​
created_at
string<date-time> | null
​
updated_at
string<date-time> | null
​
study_plan
PublicStudyPlanOut · object

Response variant — all sections optional (a study's stored prompt may not contain every section).

​
screener_questions
PublicScreenerQuestion · object[] | null
​
targeting_attributes
PublicTargetingAttribute · object[] | null
​
total_invites
integer | null
​
total_calls
integer | null
​
excellent_calls
integer | null