Waitlist
list_waitlist read
Section titled “list_waitlist ”List active waitlist entries for the brand (waiting + pending offers). Optional `date` (YYYY-MM-DD) narrows to one day.
Required scope: waitlist.read
| Parameter | Type | Required | Description |
|---|---|---|---|
brand |
string | no | Brand slug. Optional in JWT mode; required in multi-brand API-key mode. |
date |
string | no | |
status |
enum | no |
add_to_waitlist write
Section titled “add_to_waitlist ”Add a guest to the brand’s waitlist. Phone + email optional (FOH walk-in semantics). Time window must be at least 30 minutes; service auto-widens narrower windows.
Required scope: waitlist.write
| Parameter | Type | Required | Description |
|---|---|---|---|
brand |
string | no | Brand slug. Optional in JWT mode; required in multi-brand API-key mode. |
name |
string | yes | |
phone |
string | no | |
email |
string | no | |
partySize |
number | yes | |
date |
string | yes | |
timeWindowStart |
string | yes | |
timeWindowEnd |
string | yes | |
notes |
string | no | |
idempotencyKey |
string | no |
cancel_waitlist_entry write
Section titled “cancel_waitlist_entry ”Cancel a waitlist entry by id (operator-initiated). Use when a guest told you they no longer need the table.
Required scope: waitlist.write
| Parameter | Type | Required | Description |
|---|---|---|---|
brand |
string | no | Brand slug. Optional in JWT mode; required in multi-brand API-key mode. |
id |
string | yes | |
reason |
string | no | |
idempotencyKey |
string | no |