Participants
Create Participants
Queue up to 100 invitations. Poll the returned job before listing participants.
POST
/
api
/
public
/
v1
/
participants
/
Create Participants
curl --request POST \
--url https://api.userintuition.ai/api/public/v1/participants/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"study_id": "11111111-2222-3333-4444-555555555555",
"participants": [
{
"email": "alex@example.com",
"silent": false
},
{
"email": "sam@example.com",
"silent": true
}
]
}
'import requests
url = "https://api.userintuition.ai/api/public/v1/participants/"
payload = {
"study_id": "11111111-2222-3333-4444-555555555555",
"participants": [
{
"email": "alex@example.com",
"silent": False
},
{
"email": "sam@example.com",
"silent": True
}
]
}
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_id: '11111111-2222-3333-4444-555555555555',
participants: [
{email: 'alex@example.com', silent: false},
{email: 'sam@example.com', silent: true}
]
})
};
fetch('https://api.userintuition.ai/api/public/v1/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/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_id' => '11111111-2222-3333-4444-555555555555',
'participants' => [
[
'email' => 'alex@example.com',
'silent' => false
],
[
'email' => 'sam@example.com',
'silent' => 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/participants/"
payload := strings.NewReader("{\n \"study_id\": \"11111111-2222-3333-4444-555555555555\",\n \"participants\": [\n {\n \"email\": \"alex@example.com\",\n \"silent\": false\n },\n {\n \"email\": \"sam@example.com\",\n \"silent\": true\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/participants/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"study_id\": \"11111111-2222-3333-4444-555555555555\",\n \"participants\": [\n {\n \"email\": \"alex@example.com\",\n \"silent\": false\n },\n {\n \"email\": \"sam@example.com\",\n \"silent\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.userintuition.ai/api/public/v1/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_id\": \"11111111-2222-3333-4444-555555555555\",\n \"participants\": [\n {\n \"email\": \"alex@example.com\",\n \"silent\": false\n },\n {\n \"email\": \"sam@example.com\",\n \"silent\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"job_id": "<string>",
"status": "pending",
"completed": true,
"result_url": "<string>",
"total_count": 123,
"error": "<string>"
}{
"detail": "<unknown>",
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcome": "not_started",
"recovery_action": "<string>",
"docs_url": "<string>"
}
}{
"detail": "<unknown>",
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcome": "not_started",
"recovery_action": "<string>",
"docs_url": "<string>"
}
}Authorizations
Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.
Headers
Platform admins only: choose an organization for scoped reads and writes. Required to change another organization's study or use its wallet.
Maximum string length:
128Body
application/json
Response
Successful Response
Available options:
pending, running, succeeded, failed True when work has finished successfully
Fetch the created resource after success
Requested participant count for a batch
A safe failure summary; internal details are never returned
Was this page helpful?
⌘I
Create Participants
curl --request POST \
--url https://api.userintuition.ai/api/public/v1/participants/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"study_id": "11111111-2222-3333-4444-555555555555",
"participants": [
{
"email": "alex@example.com",
"silent": false
},
{
"email": "sam@example.com",
"silent": true
}
]
}
'import requests
url = "https://api.userintuition.ai/api/public/v1/participants/"
payload = {
"study_id": "11111111-2222-3333-4444-555555555555",
"participants": [
{
"email": "alex@example.com",
"silent": False
},
{
"email": "sam@example.com",
"silent": True
}
]
}
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_id: '11111111-2222-3333-4444-555555555555',
participants: [
{email: 'alex@example.com', silent: false},
{email: 'sam@example.com', silent: true}
]
})
};
fetch('https://api.userintuition.ai/api/public/v1/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/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_id' => '11111111-2222-3333-4444-555555555555',
'participants' => [
[
'email' => 'alex@example.com',
'silent' => false
],
[
'email' => 'sam@example.com',
'silent' => 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/participants/"
payload := strings.NewReader("{\n \"study_id\": \"11111111-2222-3333-4444-555555555555\",\n \"participants\": [\n {\n \"email\": \"alex@example.com\",\n \"silent\": false\n },\n {\n \"email\": \"sam@example.com\",\n \"silent\": true\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/participants/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"study_id\": \"11111111-2222-3333-4444-555555555555\",\n \"participants\": [\n {\n \"email\": \"alex@example.com\",\n \"silent\": false\n },\n {\n \"email\": \"sam@example.com\",\n \"silent\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.userintuition.ai/api/public/v1/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_id\": \"11111111-2222-3333-4444-555555555555\",\n \"participants\": [\n {\n \"email\": \"alex@example.com\",\n \"silent\": false\n },\n {\n \"email\": \"sam@example.com\",\n \"silent\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"job_id": "<string>",
"status": "pending",
"completed": true,
"result_url": "<string>",
"total_count": 123,
"error": "<string>"
}{
"detail": "<unknown>",
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcome": "not_started",
"recovery_action": "<string>",
"docs_url": "<string>"
}
}{
"detail": "<unknown>",
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcome": "not_started",
"recovery_action": "<string>",
"docs_url": "<string>"
}
}
