Skip to main content
PATCH
/
v1
/
projects
/
{projectId}
/
screener-responses
/
{screenerResponseId}
/
invite
Invite participant
curl --request PATCH \
  --url https://api-staging.respondent.io/v1/projects/{projectId}/screener-responses/{screenerResponseId}/invite \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-secret: <x-api-secret>' \
  --data '
{
  "remoteCommunicationDetails": "<string>",
  "meetingLink": "<string>",
  "bookingLink": "<string>",
  "message": "<string>"
}
'
{
  "qualified": true,
  "percentage": 123,
  "responses": [
    {
      "questionId": "<string>",
      "questionText": "<string>",
      "type": "<string>",
      "answers": [
        {
          "id": "<string>",
          "uid": "<string>",
          "text": "<string>",
          "answerValue": 123,
          "goToQuestionUid": "<string>",
          "isOther": true,
          "other": "<string>"
        }
      ],
      "qualify": true,
      "order": 123,
      "skipped": true,
      "shown": true
    }
  ],
  "totalTime": 123,
  "matching": {
    "isGenderMatch": true,
    "isAgeMatch": true,
    "isEthnicityMatch": true,
    "isEducationMatch": true,
    "questionsQualified": true,
    "isLocationMatch": true,
    "isIndustryMatch": true,
    "isJobTitleMatch": true,
    "isHouseholdIncomeMatch": true,
    "isCompanySizeMatch": true,
    "isTopicsMatch": true
  },
  "visibility": {
    "status": "VISIBLE"
  },
  "id": "<string>",
  "projectId": "<string>",
  "userId": "<string>",
  "qualifiedPendingIdVerification": true,
  "favorite": true,
  "hidden": true,
  "isNew": true,
  "inviteSentAt": "2023-11-07T05:31:56Z",
  "scheduledAt": "2023-11-07T05:31:56Z",
  "statusUpdatedAt": "2023-11-07T05:31:56Z",
  "ndaUrl": "<string>",
  "ndaAgree": true,
  "project": {
    "name": "<string>",
    "incentive": 123,
    "id": "<string>",
    "organizationId": "<string>",
    "teamId": "<string>"
  },
  "profile": {
    "id": "<string>",
    "userId": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "skills": [
      {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "validated": false,
        "type": "skill"
      }
    ],
    "picture": "<string>"
  },
  "externalProject": {
    "researcherId": "<string>",
    "bookingUrl": "<string>",
    "meetingCancelLink": "<string>",
    "bookedDate": "2023-11-07T05:31:56Z",
    "timezone": "<string>"
  },
  "invitation": {
    "id": "<string>",
    "remoteCommunicationDetails": "<string>",
    "event": {
      "uid": "<string>"
    },
    "message": null,
    "videoProvider": {
      "loginProviderId": "<string>",
      "userId": "<string>"
    }
  },
  "shortNoticeCancel": true,
  "message": "<string>",
  "rejection": {
    "message": "<string>",
    "rejectedAt": "2023-11-07T05:31:56Z"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "task": {
    "completedAt": "<string>"
  }
}

​
Moderated vs unmoderated studies

For unmoderated studies or surveys, provide a meetingLink — this URL is included in the participant’s invitation email as the study link.

Headers

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

Path Parameters

​
projectId
string
required
​
screenerResponseId
string
required

Body

application/json
​
remoteCommunicationDetails
string
deprecated

Use meetingLink instead. Note: meetingLink will not be used as the bookingUrl on the screener response.

​
meetingLink
string

If the project is an Unmoderated study, this URL will be included in the particiapnt's invitation email, allowing them to access the study. This will override the remoteCommunicationDetails defined in the project. If a project is remote, this should be the link to the research study. Note: It will NOT be used as the bookingUrl on the screener

​
bookingLink
string

If the project is a Moderated study, this URL will be included in the participant's invitation email, allowing them to schedule their research session. Will be used to write bookingUrl on screener response. Must pass meetingLink as well.

​
message
string

Will be sent in the invitation to the participant. This will override the special instructions defined in the project.

Response

200 - application/json
​
qualified
boolean
required
​
percentage
number
required
​
status
enum<string>
required
Available options:
PENDING,
INVITED,
SCHEDULED,
ATTENDED,
NOSHOW,
INVALIDRESPONSE,
REJECTEDQUALITY,
PAID,
CANCELLED
​
responses
object[]
required
​
totalTime
number
required
​
matching
object
required
​
visibility
object
required

The visibility status of the screener response. If a screener response is visible, it can be interacted with (invited etc). If a screener response is not visible, it cannot be interacted with. A screener may be hidden for various reasons, and a screener can change from visible to not visible at any time if a participant or screener is found to be untrustworthy. There is a webhook that will notify the client when a screener response changes visibility.

​
id
string
required
​
projectId
string
required
​
userId
string
required
​
qualifiedPendingIdVerification
boolean
  • This property is set to true (with qualified set to false) if the participant has qualified based on their responses to the screener, but is in the process of verifying their identity.
  • Once the participant has completed ID verification, qualifiedPendingIdVerification will be set to false.
    • If the verification was successful, qualified will be set to true.
    • If the verification failed, qualified will remain set to false unless they were manually qualified through the qualification endpoint (PATCH /projects/{projectId}/screener-responses/{screenerResponseId}/qualify).
​
favorite
boolean
​
hidden
boolean
​
isNew
boolean
​
inviteSentAt
string<date-time>
​
scheduledAt
string<date-time>
​
statusUpdatedAt
string<date-time>
​
ndaUrl
string
​
ndaAgree
boolean
​
project
object
​
profile
object
​
externalProject
object
​
invitation
object
​
actor
enum<string>
Available options:
researcher,
respondent,
admin
​
reason
enum<string>
Available options:
time,
final
​
shortNoticeCancel
boolean
​
message
string
​
rejection
object
​
createdAt
string<date-time>
​
task
object