Waitlist Check Ins
Check in or register a participant to a waitlist who arrives at the
service territory for a drop-in appointment.
- Resource
-
/connect/scheduling/waitlist-checkin
- Resource example
-
https://yourInstance.salesforce.com/services/data/v63.0/connect/scheduling/waitlist-checkin
- Available version
- 59.0
- HTTP methods
- POST
- Request body for POST
-
- Root XML tag
- <waitlistCheckIn>
- JSON example
-
{ "lead": { "firstName":"Tom", "lastName":"Scott", "phone":"012-345-6789", "email":"tom.scott@phoenix.com", "company":"Phoenix", "extendedFields":[] }, "participantId":"00Q5h00000JdQWzEAN", "waitlistId": "0D3B0000000S2SeNOP", "workTypeId":"08q5h000000UuEcAAK", "workTypeGroupId" : "0VSRM0000004MBk4AM", "serviceResourceId":"0Hn0000000S2SeNOP", "description": "Registration for a drop-in appointment.", "extendedFields":[ { "name":"Source__c", "value":"Email" } ] }
- Properties
-
Name Type Description Required or Optional Available Version description String Description of the participant. Optional 59.0 extendedFields Extended Field Input[] Details of the extended custom fields. Optional 59.0 lead Lead Input Details of the prospect or lead. Required if the participantId parameter isn’t specified. 59.0 participantId String ID of the participant with an appointment. The participant can be an account, a contact, or a lead. Required if the lead parameter isn’t specified. 59.0 serviceResourceId String ID of the service resource. Optional 59.0 waitlistId String ID of the waitlist that the participant is checked in. Required 59.0 workTypeGroupId String ID of the work type group. Required if the workTypeId parameter isn’t specified. 59.0 workTypeId String ID of the work type that represents the topic for the appointment. Required if the workTypeGroupId parameter isn’t specified. 59.0
- Response body for POST
- Waitlist Check In