Waitlist Tools
Manage the waitlist for experiences and rental products. Add customers to the waitlist when items are unavailable, send availability notifications, and track conversion statistics.
Required scope: bookings:read for read tools, bookings:write for write tools
Tools Overview
| Tool | Description | Read-only? |
|---|---|---|
view_waitlist | View waitlist entries with filters | Yes |
add_to_waitlist | Add a customer to the waitlist | No |
notify_waitlist_entry | Send availability notification to a waitlist entry | No |
get_waitlist_stats | Get waitlist statistics and conversion rates | Yes |
view_waitlist
View waitlist entries. Can filter by type (experience or rental), status, and search term.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
type | string | No | Filter by type: experience, rental |
status | string | No | Filter by status: waiting, notified, booked, cancelled |
search | string | No | Search by name or email |
limit | integer | No | Max results (default 10) |
add_to_waitlist
Add a customer to the waitlist for an experience schedule or rental product.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
type | string | Yes | Waitlist type: experience or rental |
name | string | Yes | Customer name |
email | string | Yes | Customer email |
phone | string | No | Customer phone |
experience_id | integer | No | Experience ID (required for experience type) |
schedule_id | integer | No | Schedule ID (required for experience type) |
product_id | integer | No | Product ID (required for rental type) |
variation_id | integer | No | Variation ID (for rental type) |
desired_start_at | string | No | Desired start ISO 8601 datetime (for rental type) |
desired_end_at | string | No | Desired end ISO 8601 datetime (for rental type) |
quantity | integer | No | Number of spots/items (default 1) |
notes | string | No | Customer notes |
For experience waitlist entries, provide experience_id and schedule_id. For rental waitlist entries, provide product_id and optionally variation_id with desired dates.
notify_waitlist_entry
Send an availability email notification to a specific waitlist entry. This notifies the customer that the item or experience they were waiting for is now available.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
waitlist_entry_id | integer | Yes | Waitlist entry ID to notify |
get_waitlist_stats
Get waitlist statistics: total waiting, notified today, conversions this month, and conversion rate.
Parameters
None.
Related
- Waitlist REST API - REST API endpoints for waitlist
- Bookings Tools - Create bookings after waitlist conversion
- Experiences Tools - Check experience availability
- Products Tools - Check product availability