Skip to main content
POST
Create Participants

Authorizations

Authorization
string
header
required

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

Body

application/json

Create multiple participants for one study.

study_id
string
required

The study to invite these participants to

participants
PublicParticipantInviteInput · object[]
required
Required array length: 1 - 100 elements

Response

Successful Response

id
string
required
study_id
string | null

The study this participant belongs to

email
string | null
reward_sent
boolean | null
reward_sent_at
string<date-time> | null
invite_sent_at
string<date-time> | null

When this participant's invitation email was sent

invite_created_at
string<date-time> | null

When this participant invitation was created