Create Study With Participants

curl --request POST \
  --url https://api.userintuition.ai/api/public/v1/studies/create-with-participants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "study": {
    "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>",
        "numeric_ranges": [
          {
            "min": 1,
            "max": 1
          }
        ]
      }
    ],
    "targeting_attributes": [
      {
        "qualification_id": 123,
        "allowed_options": [
          123
        ],
        "disallowed_options": [
          123
        ]
      }
    ],
    "byop_config": {
      "incentive_amount": 203,
      "is_incentives_enabled": true,
      "auto_send_incentives": true
    }
  },
  "participants": [
    {
      "email": "jsmith@example.com",
      "silent": false
    }
  ]
}
'

import requests

url = "https://api.userintuition.ai/api/public/v1/studies/create-with-participants"

payload = {
    "study": {
        "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>",
                "numeric_ranges": [
                    {
                        "min": 1,
                        "max": 1
                    }
                ]
            }
        ],
        "targeting_attributes": [
            {
                "qualification_id": 123,
                "allowed_options": [123],
                "disallowed_options": [123]
            }
        ],
        "byop_config": {
            "incentive_amount": 203,
            "is_incentives_enabled": True,
            "auto_send_incentives": True
        }
    },
    "participants": [
        {
            "email": "jsmith@example.com",
            "silent": False
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    study: {
      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>',
          numeric_ranges: [{min: 1, max: 1}]
        }
      ],
      targeting_attributes: [{qualification_id: 123, allowed_options: [123], disallowed_options: [123]}],
      byop_config: {incentive_amount: 203, is_incentives_enabled: true, auto_send_incentives: true}
    },
    participants: [{email: 'jsmith@example.com', silent: false}]
  })
};

fetch('https://api.userintuition.ai/api/public/v1/studies/create-with-participants', 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/create-with-participants",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'study' => [
        '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>',
                                'numeric_ranges' => [
                                                                [
                                                                                                                                'min' => 1,
                                                                                                                                'max' => 1
                                                                ]
                                ]
                ]
        ],
        'targeting_attributes' => [
                [
                                'qualification_id' => 123,
                                'allowed_options' => [
                                                                123
                                ],
                                'disallowed_options' => [
                                                                123
                                ]
                ]
        ],
        'byop_config' => [
                'incentive_amount' => 203,
                'is_incentives_enabled' => true,
                'auto_send_incentives' => true
        ]
    ],
    'participants' => [
        [
                'email' => 'jsmith@example.com',
                'silent' => false
        ]
    ]
  ]),
  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/create-with-participants"

	payload := strings.NewReader("{\n  \"study\": {\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    \"screener_questions\": [\n      {\n        \"text\": \"<string>\",\n        \"type\": \"single_select\",\n        \"options\": [\n          {\n            \"text\": \"<string>\",\n            \"disqualify\": false,\n            \"id\": \"<string>\"\n          }\n        ],\n        \"order\": 123,\n        \"id\": \"<string>\",\n        \"numeric_ranges\": [\n          {\n            \"min\": 1,\n            \"max\": 1\n          }\n        ]\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  },\n  \"participants\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"silent\": false\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.userintuition.ai/api/public/v1/studies/create-with-participants")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"study\": {\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    \"screener_questions\": [\n      {\n        \"text\": \"<string>\",\n        \"type\": \"single_select\",\n        \"options\": [\n          {\n            \"text\": \"<string>\",\n            \"disqualify\": false,\n            \"id\": \"<string>\"\n          }\n        ],\n        \"order\": 123,\n        \"id\": \"<string>\",\n        \"numeric_ranges\": [\n          {\n            \"min\": 1,\n            \"max\": 1\n          }\n        ]\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  },\n  \"participants\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"silent\": false\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.userintuition.ai/api/public/v1/studies/create-with-participants")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"study\": {\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    \"screener_questions\": [\n      {\n        \"text\": \"<string>\",\n        \"type\": \"single_select\",\n        \"options\": [\n          {\n            \"text\": \"<string>\",\n            \"disqualify\": false,\n            \"id\": \"<string>\"\n          }\n        ],\n        \"order\": 123,\n        \"id\": \"<string>\",\n        \"numeric_ranges\": [\n          {\n            \"min\": 1,\n            \"max\": 1\n          }\n        ]\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  },\n  \"participants\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"silent\": false\n    }\n  ]\n}"

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

{
  "study": {
    "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>",
        "order": 123,
        "options": [
          {
            "id": "<string>",
            "text": "<string>",
            "disqualify": true
          }
        ],
        "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
  },
  "participants": [
    {
      "id": "<string>",
      "study_id": "<string>",
      "email": "<string>",
      "reward_sent": true,
      "reward_sent_at": "2023-11-07T05:31:56Z",
      "invite_sent_at": "2023-11-07T05:31:56Z",
      "invite_created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

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