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.

Headers

Idempotency-Key
string | null
X-UI-Organization-ID
string | null

Choose an organization you belong to for scoped reads, writes, and billing. Users can belong to multiple organizations. Platform administrators may select any organization in this app.

Maximum string length: 128

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

job_id
string
required
status
enum<string>
required
Available options:
pending,
running,
succeeded,
failed
completed
boolean
required

True when work has finished successfully

result_url
string | null

Fetch the created resource after success

total_count
integer | null

Requested participant count for a batch

error
string | null

A safe failure summary; internal details are never returned