Waitlist Participants Update

Output representation of a waitlist participant move response.

JSON example

1{
2   "message": "Participant successfully moved to first in the Main Lobby waitlist.",
3   "status": "success",
4   "waitlistParticipantId": "12oRM0000004FGiYAM"
5}

Property Name	Type	Description	Filter Group and Version	Available Version
`message`	String	Human-readable description of the result. Display this value to end users rather than branching on it. On success, the value matches one of these templates, depending on the value of `targetPosition`: `Participant successfully moved to first in the {WaitlistName} waitlist.` for `1`, or `Participant successfully moved to last in the {WaitlistName} waitlist.` for `-1`. In API version 65.0 and later, a positive integer other than `1` returns `Participant successfully repositioned in the {WaitlistName} waitlist.`	Small, 62.0	62.0
`status`	String	Result of the request. The value is `success` on an HTTP 200 response. Use this property to branch programmatically.	Small, 62.0	62.0
`waitlistParticipantId`	String	ID of the waitlist participant record that was moved.	Small, 62.0	62.0

The response doesn't include the participant's new position or the updated waitlist ordering. To read the new order, call GET /connect/scheduling/waitlists and use the array order of waitlistParticipants as the position.

Note

Connect REST API Developer Guide

Waitlist Participants Update