Skip to main content
POST
Create invitations

Authorizations

Authorization
string
header
required

Use API-Key YOUR_API_KEY. The key selects the Production or Development environment.

Path Parameters

studyId
string<uuid>
required

Body

application/json

A request for one batch of invitations.

count
integer
required

How many invitations to generate.

Required range: 1 <= x <= 10000
idempotencyKey
string
required

A key you choose to name this batch. Sending the same key again returns the batch it first created and generates nothing new, even if count differs, so a retried request never doubles up on invitations.

Minimum string length: 1

Response

Invitation batch created or returned for the idempotency key.

One generated invitation batch.

invitations
object[]
required

Generated invitations in creation order.