Take a customer off the waitlist
https://api.app2email.com/v1/{number}/bookings/waitlist/{reference}/remove Scope: bookings:manage. Not with a sandbox key. The customer is not messaged. Sends waitlist.removed. An entry that is already closed answers 200 as it is.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The entry's reference (or its id).
e.g.WL-4HT9XC
Responses
Fields
- success boolean
- request_id string
- entry object
A customer waiting for a time on a full day of a service. Also the data of the waitlist.* events.
26 fields
- id integer
- reference string
The entry's code. The customer confirms a public-link entry by sending "Join waitlist WL-XXXXXX" on WhatsApp, and leaves with "Leave waitlist WL-XXXXXX".
e.g.WL-4HT9XC - status string
pending_confirm: joined on the public booking page, not confirmed on WhatsApp yet. waiting. notified: offered a time that opened (up to 3 offers). booked: the customer booked that service that day. expired: the day passed. removed.
pending_confirmwaitingnotifiedbookedexpiredremoved - service_id string
- service_name string
- provider_id string
'' = anyone.
- provider_name string
- date string
The wanted day, YYYY-MM-DD in the business time zone.
- date_label string
- slot_id string
'' = any time that day; else the full group time yyyy-MM-ddTHH:mm.
- time_label string
- contact string
- contact_name string
- contact_email string
- seats integer
- source string
webcalendarapi - notified_count integer
- notified_at string (date-time) | null
- appointment_id integer | null
The booking, once booked.
- note string
What the last offer did, in plain words.
- created string (date-time)
- updated string (date-time)
- day string
The same as date.
- slot_local string
The same as slot_id.
- contact_masked string
The contact with all but the last 4 digits hidden.
- created_at string (date-time)
The same as created.
- existing boolean
true: the customer was on that day's waitlist for the service already (this is that entry).
Errors
- 401 Missing, invalid, revoked or expired API key.
- 403 The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account.
- 404 The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found.
- 409 Idempotency-Key: the first request with this key is still running, or did not finish. Or a conflict: the template name exists, the webhook URL is used by another webhook, the broadcast cannot be cancelled, the booking slot is taken or the booking is already cancelled, or the Flow is not published.
- 429 A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait.
- 500 Unexpected error on app2email's side.