Skip to main content
PATCH
Patch Participant

Authorizations

Authorization
string
header
required

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

Headers

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

Path Parameters

participant_id
string
required

Body

application/json
email
string<email> | null

New email, or null to clear the email

external_id
string | null
Required string length: 1 - 128
metadata
Metadata · object

Response

Successful Response

A BYOP invitation/participation record, not a deduplicated person.

Panel recruiting is represented by the panel endpoints, not by synthetic participant records on this resource.

id
string
required
status
enum<string>
required

Invitation and interview progress; created means no invitation email was sent

Available options:
created,
invited,
started,
completed,
screened_out
external_id
string | null

Customer ID, unique among active BYOP invitations in this study

Required string length: 1 - 128
metadata
Metadata · object

Up to 20 scalar CRM fields and 4 KiB total

study_id
string | null

The study this participant belongs to

email
string | null

Personal interview link for this invitation; usable when the study is provisioned and active

interview_count
integer
default:0

Visible non-test interview sessions for this invitation, not unique people

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