Body
The timezone of the scheduled booking Date. Must be a valid IANA timezone. For a list of valid timezones, see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
Note: we expect the date to be in the format of YYYY-MM-DDTHH:MM:SS (ISO 8601), in the timezone specified. Offset will be removed from the input date. Date will be stored in UTC.
Deprecated: Use bookingLink
instead to allow for a separation between the booking link and the meeting link.
BookingUrl is optional and can be used if researcher wants to update the booking url during schedule.
This will also update the invitation remoteCommunicationDetails.
bookingLink
is optional and can be used if researcher wants to update the bookingUrl during schedule.
meetingLink
is optional and can be used if researcher wants to update the remoteCommunicationDetails that was set during invitation.
Link to cancel a meeting. If not set, bookingLink
(or bookingUrl
, which is deprecated) will be used if set, otherwise bookingUrl
from project.externalResearcer
will be used.
Response
PENDING
, INVITED
, SCHEDULED
, ATTENDED
, NOSHOW
, INVALIDRESPONSE
, REJECTEDQUALITY
, PAID
, CANCELLED
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.
- This property is set to
true
(withqualified
set tofalse
) 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 totrue
. - If the verification failed,
qualified
will remain set tofalse
unless they were manually qualified through the qualification endpoint (PATCH /projects/{projectId}/screener-responses/{screenerResponseId}/qualify
).
- If the verification was successful,
researcher
, respondent
, admin
time
, final