Set the scheduled time and timezone after booking a time with a participant. This will be displayed to the participant.
curl --request PATCH \
--url https://api-staging.respondent.io/v1/projects/{projectId}/screener-responses/{screenerResponseId}/schedule \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--header 'x-api-secret: <x-api-secret>' \
--data '{
"bookingUrl": "<string>",
"bookingLink": "<string>",
"meetingLink": "<string>",
"meetingCancelLink": "<string>",
"timezone": "<string>",
"bookedDate": "2023-11-07T05:31:56Z"
}'
{
"qualified": true,
"qualifiedPendingIdVerification": true,
"percentage": 123,
"status": "PENDING",
"favorite": true,
"hidden": true,
"responses": [
{
"questionId": "<string>",
"questionText": "<string>",
"order": 123,
"type": "<string>",
"questionType": "radio",
"answers": [
{
"id": "<string>",
"uid": "<string>",
"text": "<string>",
"answerValue": 123,
"goToQuestionUid": "<string>",
"isOther": true,
"other": "<string>"
}
],
"qualify": true
}
],
"totalTime": 123,
"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>",
"picture": "<string>",
"skills": [
{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"validated": false,
"type": "skill"
}
]
},
"matching": {
"isGenderMatch": true,
"isAgeMatch": true,
"isEthnicityMatch": true,
"isEducationMatch": true,
"questionsQualified": true,
"isLocationMatch": true,
"isIndustryMatch": true,
"isJobTitleMatch": true,
"isHouseholdIncomeMatch": true,
"isCompanySizeMatch": true,
"isTopicsMatch": true
},
"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>",
"providerKey": "zoom",
"userId": "<string>"
}
},
"actor": "researcher",
"reason": "time",
"shortNoticeCancel": true,
"message": "<string>",
"rejection": {
"message": "<string>",
"rejectedAt": "2023-11-07T05:31:56Z"
},
"visibility": {
"status": "VISIBLE"
},
"createdAt": "2023-11-07T05:31:56Z",
"task": {
"completedAt": "<string>"
},
"id": "<string>",
"projectId": "<string>",
"userId": "<string>"
}
The response is of type object
.
curl --request PATCH \
--url https://api-staging.respondent.io/v1/projects/{projectId}/screener-responses/{screenerResponseId}/schedule \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--header 'x-api-secret: <x-api-secret>' \
--data '{
"bookingUrl": "<string>",
"bookingLink": "<string>",
"meetingLink": "<string>",
"meetingCancelLink": "<string>",
"timezone": "<string>",
"bookedDate": "2023-11-07T05:31:56Z"
}'
{
"qualified": true,
"qualifiedPendingIdVerification": true,
"percentage": 123,
"status": "PENDING",
"favorite": true,
"hidden": true,
"responses": [
{
"questionId": "<string>",
"questionText": "<string>",
"order": 123,
"type": "<string>",
"questionType": "radio",
"answers": [
{
"id": "<string>",
"uid": "<string>",
"text": "<string>",
"answerValue": 123,
"goToQuestionUid": "<string>",
"isOther": true,
"other": "<string>"
}
],
"qualify": true
}
],
"totalTime": 123,
"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>",
"picture": "<string>",
"skills": [
{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"validated": false,
"type": "skill"
}
]
},
"matching": {
"isGenderMatch": true,
"isAgeMatch": true,
"isEthnicityMatch": true,
"isEducationMatch": true,
"questionsQualified": true,
"isLocationMatch": true,
"isIndustryMatch": true,
"isJobTitleMatch": true,
"isHouseholdIncomeMatch": true,
"isCompanySizeMatch": true,
"isTopicsMatch": true
},
"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>",
"providerKey": "zoom",
"userId": "<string>"
}
},
"actor": "researcher",
"reason": "time",
"shortNoticeCancel": true,
"message": "<string>",
"rejection": {
"message": "<string>",
"rejectedAt": "2023-11-07T05:31:56Z"
},
"visibility": {
"status": "VISIBLE"
},
"createdAt": "2023-11-07T05:31:56Z",
"task": {
"completedAt": "<string>"
},
"id": "<string>",
"projectId": "<string>",
"userId": "<string>"
}