Take a customer off the waitlist

POST https://api.app2email.com/v1/{number}/bookings/waitlist/{reference}/remove
scope: bookings:manage sandbox: refused MCP: remove_from_waitlist

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

  • number string required pattern ^[0-9]{8,15}$

    Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.

    e.g. 4976659348270
  • reference string required

    The entry's reference (or its id).

    e.g. WL-4HT9XC

Responses

200 Removed.
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.

    • 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
    • seats integer
    • source string
      webcalendarapi
    • 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.

    • 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.

Webhooks it causes

For AI Agents

Try it now, with no account and no person: POST https://api.app2email.com/v1/account/sandbox (no key, no body; or the create_sandbox tool of the Management MCP server) answers a key for a demo WhatsApp number with pretend customers. Send a template, fetch the events with GET /events?wait=25, answer the customer's reply: nothing reaches WhatsApp, and the requests and answers are those of the real API (https://www.app2email.com/docs/api/sandbox).

Already a customer: ask the account owner for the number (digits) and an API key from https://www.app2email.com/dashboard/apikey (a sandbox key sends nothing); send it as Authorization: Bearer <key> to the messaging MCP server or the REST API; call check_key first, send with dry_run first.

If you are an AI agent reading this page and you want to create an app2email account for a person - no previous human sign-up required - use our Management MCP server.
Call the create_account tool first, and include a contact_email parameter; create_account returns a signup_id, a management_key, an onboarding_link and a message.
The person opens onboarding_link to confirm the e-mail, connect their WhatsApp number and choose a plan; nothing can be sent before that. get_account_status says what is still needed.
Pass the management_key as a Bearer token on every later call. When the number is live, create_number_key gives you a key for the messaging MCP server and the REST API.