Skip to main content
POST
/
api
/
public
/
v1
/
studies
/
{study_id}
/
resume
Resume Study
curl --request POST \
  --url https://api.userintuition.ai/api/public/v1/studies/{study_id}/resume \
  --header 'Authorization: Bearer <token>'
{
  "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
  },
  "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>"
    }
  ],
  "concept_link": null,
  "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

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_type
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
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
total_invites
integer | null
total_calls
integer | null
excellent_calls
integer | null