Skip to main content
POST
/
api
/
public
/
v1
/
participants
/
Create Participant
curl --request POST \
  --url https://api.userintuition.ai/api/public/v1/participants/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "study_id": "<string>",
  "email": "jsmith@example.com",
  "silent": false
}
'
{
  "id": "<string>",
  "study_id": "<string>",
  "email": "<string>",
  "panel_status": "<string>",
  "reward_sent": true,
  "reward_sent_at": "2023-11-07T05:31:56Z",
  "sent_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Body

application/json
study_id
string
required

The study to invite this participant to

email
string<email> | null
silent
boolean | null
default:false

Skip sending the invitation email

Response

Successful Response

id
string
required
study_id
string | null

The study this participant belongs to

email
string | null
panel_status
string | null

Panel lifecycle status, if a panel participant

reward_sent
boolean | null
reward_sent_at
string<date-time> | null
sent_at
string<date-time> | null
created_at
string<date-time> | null