Waitlist

Notify waitlist entry

Tells a waiting party their table is ready: Maple texts the guest and the entry becomes `notified`.

此内容尚不支持你的语言。

POSThttps://api.maple.inc/v1/waitlist_entries/{entryId}/notifyAPI key

Tells a waiting party their table is ready: Maple texts the guest and the entry becomes notified. If the guest does not respond within the venue’s response window, the entry expires as expired_no_response. An entry that is no longer waiting is returned unchanged. A location where Maple is not texting guests (not rolled out yet, or the location turned guest texts off) answers 422 guest_messaging_unavailable. Requires bookings:manage.

Authorization

Send your API key as Authorization: Bearer <key>: mpk_test_… against the sandbox (https://api.staging.maple.inc/v1), mpk_live_… against production. See Authentication. The samples read the key from MAPLE_KEY and the base URL from MAPLE_BASE, as set up in the Quickstart.

Parameters

entryId string path required

Responses

200 OK

object string required

Always waitlist_entry.
id string required

Opaque, prefixed bkw_….
livemode boolean required
created number required
location_id string required
status string required

One of waiting, notified, on_my_way, seated, removed_by_guest, removed_by_venue, expired_no_response.
party_size integer required
position integer or null required

1-based place in the queue while the entry is active; null once it is seated, removed, or expired.
quoted_wait object or null required

The wait quoted when the party joined, refreshed when it is notified. Null when none could be quoted.
quoted_wait.parties_ahead integer required
quoted_wait.wait_minutes object required
quoted_wait.wait_minutes.min integer required
quoted_wait.wait_minutes.max integer required
joined_at string required

ISO-8601 UTC instant.
notified_at string or null required

ISO-8601 UTC instant the table-ready text was sent.
booking_id string or null required

The walk-in booking created when the party was seated; read it with GET /bookings/{bookingId}.
channel string required

The channel the party joined on, e.g. api_partner, voice_ai, internal.
guest object required
guest.first_name string or null required
guest.last_name string or null required
guest.phone string or null required

E.164, when the guest left one.
guest.phone_last_four string or null required
guest.email string or null required

Errors

400 Bad request DeveloperApiBadRequest
401 Unauthorized DeveloperApiUnauthorized
403 Forbidden DeveloperApiForbidden
404 Not found DeveloperApiNotFound
409 Conflict DeveloperApiConflict
422 Unprocessable DeveloperApiUnprocessable
429 Too many requests DeveloperApiRateLimited

Every error body names the error in _tag, explains it in message, and says where to report it in feedback. See Errors.

A 429 also sends Retry-After: Seconds to wait before retrying; also returned as retry_after in the body.

Notify waitlist entry

curl -X POST "$MAPLE_BASE/waitlist_entries/bkw_123/notify" \
  -H "Authorization: Bearer $MAPLE_KEY"

import os
import requests

r = requests.post(
    f"{os.environ['MAPLE_BASE']}/waitlist_entries/bkw_123/notify",
    headers={"Authorization": f"Bearer {os.environ['MAPLE_KEY']}"},
    timeout=30,
)
r.raise_for_status()
print(r.json())

const res = await fetch(`${process.env.MAPLE_BASE}/waitlist_entries/bkw_123/notify`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MAPLE_KEY}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());

{
  "object": "waitlist_entry",
  "id": "string",
  "livemode": true,
  "created": 1.5,
  "location_id": "str_123",
  "status": "waiting",
  "party_size": 1,
  "position": 1,
  "quoted_wait": {
    "parties_ahead": 1,
    "wait_minutes": {
      "min": 1,
      "max": 1
    }
  },
  "joined_at": "string",
  "notified_at": "string",
  "booking_id": "bkg_123",
  "channel": "string",
  "guest": {
    "first_name": "Ada",
    "last_name": "Lovelace",
    "phone": "+15555550123",
    "phone_last_four": "string",
    "email": "guest@example.com"
  }
}

{
  "_tag": "DeveloperApiBadRequest",
  "code": "string",
  "message": "string",
  "feedback": "string"
}