Response statuses
Statuses
/v1/projects/{projectId}/screener-responses/{screenerResponseId}/
Updating a participant status in a study happens through screener response endpoints.
| Call | Change | Available actions following change | Use case |
|---|---|---|---|
| Qualify | Participant status updated to Qualified | Invite, Disqualify, Hide, Report | Screener responses will be passed with a qualified status of true or false based on a predetermined criteria. If Respondent passes a participant with a qualified = false status your researchers have the ability to manually qualify a participant before inviting them. |
| Hide | NA | NA | Allows researchers to hide a participant from project view. This signal shows us that their is nothing "wrong" with the participant but they are not right for this project and can be removed from view. |
| Invite | Participant status updated to Invited | Mark as attended, Cancel invite, Reject, Report | When a researcher wants to work with a participant we need an invite signal to pass along booking or task data to the participant. |
| Cancel Invite | Revert status to previous state | Invite, Disqualify, Hide, Report | Sometimes mistakes happen! If a participant is accidentally invited to a study, they can be uninvited with this call. This will remove their ability to schedule a meeting or complete a linked study. |
| Schedule | Participant status updated to Scheduled | Join meeting, Mark as attended, Cancel, Cancel and reinvite, Reject, No Show, Report | For moderated projects only. After a participant has booked a scheduled time on your platform we need the bookedDate and timezone so that their dashboard can reflect the time they are expected to attend. If the booking URL passed in the project and the meeting URL are different an updated bookingURL can be passed with a meeting link in this call. |
| Cancel booking | Participant status updated to Cancelled | Re-invite, Report | For moderated projects only. If a researcher cannot make a booked meeting and does not immediately intend to reschedule, this call will remove the booked time information from a participant's dashboard. |
| Cancel booking reinvite | Participant status updated to Invited | Mark as attended, Cancel invite, Reject, Report | For moderated projects only. If a researcher cannot make a booked meeting but wants to reschedule, this call will remove the existing booked time information from a participant's dashboard and let them re-book a meeting time. |
| Attended | Participant status updated to Attended | No show, Report | After a participant has completed a session or task this call will mark them as "attended" for moderated projects or "complete" for unmoderated projects. Receiving this call kicks off incentive payout to the participant. |
| Rejected | Participant status updated to Rejected Quality | NA | After a participant has completed a session or task, this API call is used to indicate that the quality of the response did not meet expectations. Receiving this API call stops any incentive payment, marks the participant as Rejected Quality, and sends participant an email letting them know. |
| No show | Participant status updated to No show (for moderated) and Invalid Response (for unmod/survey) | NA | For moderated projects only, available after scheduled meeting time has passed. When a participant does not attend a scheduled meeting and is not intended to be given another chance, they should be marked as no show to signify their exclusion from the study. For unmoderated and survey, this API call can be used to indicate that they did not complete the task, but Rejected API call can also be used. Receiving this API call stops any incentive payment and sends participant an email letting them know. |
| Favorite | Non status related flag added to participant | NA | Allows researchers to flag a participant as a favorite. This is largely a tagging functionality that can help identify repeat participants that researchers may want to work with. |
| Report | NA | Allows for researchers to report a suspicious or fraudulent participant. Reported participants cannot apply to future studies from your organization, and we investigate to determine if participant should be removed from platform entirely. |
Example status flows
Moderated
- Invite -> Schedule -> Attended/No show/Reject
- Qualify -> Invite -> Schedule -> Attended/No show/Reject
- Invite -> Schedule -> Cancel booking reinvite -> Schedule -> Attended/No show/Reject
Unmoderated
- Invite -> Attended/No show/Reject
- Invite -> Cancel invite
- Qualify -> Invite -> Attended/No show -> Favorite
Updated 3 months ago