Waitlist API

The Waitlist API allows customers to express interest when experiences are sold out or rental products are unavailable for their desired dates. When availability opens up, customers can be notified automatically or manually.

What is a Waitlist Entry?

A waitlist entry records a customer's interest in an item that is currently unavailable. It tracks:

• Customer information: Name, email, phone
• Item details: Which experience schedule or rental product they want
• Desired dates: For rentals, the preferred pickup/return period
• Status: Current state in the waitlist lifecycle
• Notifications: When and whether they were notified of availability

Waitlist Types

Type	Description	Required Fields
experience	Customer wants a sold-out experience session	experience_id, schedule_id
rental	Customer wants an unavailable rental product	product_id, optionally variation_id, desired_start_at, desired_end_at

Status Flow

waiting → notified → booked
       ↘ cancelled

Status	Description
waiting	Customer is on the waitlist, awaiting availability
notified	Customer has been notified that availability opened up
booked	Customer completed a booking after being notified
cancelled	Entry was cancelled by the customer or staff

API Endpoints

Method	Endpoint	Description	Scope Required
GET	/v1/waitlist	List waitlist entries with filtering	waitlist:read
GET	/v1/waitlist/{id}	Get a single waitlist entry	waitlist:read
POST	/v1/waitlist	Create a new waitlist entry	waitlist:write
PATCH	/v1/waitlist/{id}	Update a waitlist entry	waitlist:write
DELETE	/v1/waitlist/{id}	Delete a waitlist entry	waitlist:write
POST	/v1/waitlist/{id}/notify	Send availability notification	waitlist:write

Plan Requirement

The Waitlist feature requires the Pro plan. API requests to waitlist endpoints will return a 403 error with code plan_feature_required if the supplier is not on a Pro plan or trial.

Common Use Cases

Adding a customer to the waitlist

When a customer wants an experience that is sold out:

curl -X POST "https://app.equipdash.com/api/v1/waitlist" \
  -H "Authorization: Bearer eqd_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "experience",
    "name": "Jane Smith",
    "email": "jane@example.com",
    "experience_id": 42,
    "schedule_id": 156,
    "quantity": 2
  }'

Notifying a customer when availability opens

curl -X POST "https://app.equipdash.com/api/v1/waitlist/789/notify" \
  -H "Authorization: Bearer eqd_live_your_api_key"