Skip to main content
POST
Queue past-participant invites on a draft
Use this workflow when you want to choose participants before launch. Your organization needs the participant database source enabled and your team needs access to the participant database.
  1. Create a draft project. Set targetNumberOfParticipants to the number you want from the Respondent panel, or to 0 for a study inviting only past participants. Then search your team’s past participants for their profile IDs.
  2. Add the selected profiles to the draft. Set skipScreener and an invitation message for each batch. Submit separate batches if some people should complete the screener and others should skip it. Participants still need to accept any required NDA.
  3. Publish the project. Publication triggers an invitation attempt once the project is live. If the project goes to review, send the queued invitations after approval.
  4. Check the queue after publish. If participants are still queued, retry the send on the live project. A successful publish alone does not confirm delivery to everyone.
For moderated projects, set externalResearcher.bookingUrl to your scheduling page and report confirmed bookings through the scheduling endpoint. To invite people immediately to an existing live project, use batch invite.

Headers

x-api-key
string
required
x-api-secret
string
required

Path Parameters

projectId
string
required

Body

application/json
participants
object[]
required
skipScreener
boolean
required
message
string
required

Response

201 - application/json
participants
object[]
required
sent
number
required
Required range: x >= 0
lastAttempt
object
Last modified on November 18, 2026