Get wait list settings

This API used to get wait list settings associated with the specified event.
This API can be access by event admin and super admin. It will return wait list details like manualReleaseTickets, remainingTickets, timeToRespondInHours, waitListEnabled, waitListTicketReleaseMessage and many more.
To call this API, user have to pass path and query param with API URL like eventurl, recurringEventId and authentication key to authenticate user.

Here is the description of response attributes, which returns to the form of JSON.

Attributes

Description

manualReleaseTickets

Enabling this field will require you to manually release tickets from waitlist.

maxWaitListSize

This field will return number of tickets allowed for waiting, pass 0 for unlimited tickets.

maxWaitListSizeReached

This field returns boolean value of whether maximum size reached for waitlist.

phoneNumberRequired

This field returns boolean value of whether phone number required.

remainingTickets

This field returns number of remaining ticket for waitlist.

timeToRespondInDays

This field returns time to respond for a user in days.

timeToRespondInHours

This field returns time to respond for a user in hours.

timeToRespondInMinutes

This field returns time to respond for a user in minutes.

waitListEnabled

This field returns boolean value of whether waitlist is enabled.

waitListTicketReleaseMessage

This field returns message to send when tickets become available.

waitListTrigger

This field returns on which trigger waitlist should be enabled.

Here is the possible error messages, which return if any condition gets failed or required data is missing for processing.

Error Code

Error Description

200

Successfully retrieved wait list settings

401

You are not authorized to view the resource

403

Accessing the resource you were trying to reach is forbidden

404

The resource you were trying to reach is not found

4030201

Not Event Host

Language
Authentication
Header
Click Try It! to start a request and see the response here!