Special days
list_special_days read
Section titled “list_special_days ”List the restaurant’s special days — holidays / one-off closures or custom-hours days. Use to see what’s already set before changing it.
Required scope: schedule.read
| Parameter | Type | Required | Description |
|---|---|---|---|
brand |
string | no | Brand slug. Optional in JWT mode. |
from |
string | no | Optional start date YYYY-MM-DD. |
to |
string | no | Optional end date YYYY-MM-DD. |
set_special_day write
Section titled “set_special_day ”Mark a date as closed (holiday) or as a named special day. Use when an owner says ‘we’re closed on December 25’ or ‘close us on New Year’s Day’. Pass the date (YYYY-MM-DD), status (‘closed’ or ‘open’), and an optional name. If the closure would cancel existing bookings, the change is blocked with an explanation.
Required scope: schedule.write
| Parameter | Type | Required | Description |
|---|---|---|---|
brand |
string | no | Brand slug. Optional in JWT mode. |
date |
string | yes | The date, YYYY-MM-DD. |
status |
enum | yes | ‘closed’ = no service that day; ‘open’ = a named/open special day. |
name |
string | no | Label, e.g. “Christmas Day”. Defaults from status. |
idempotencyKey |
string | no |
remove_special_day write
Section titled “remove_special_day ”Remove a special day (revert a date back to normal hours). Use when an owner says ‘actually we’re open on that day after all’. If reverting would affect bookings it’s blocked with an explanation.
Required scope: schedule.write
| Parameter | Type | Required | Description |
|---|---|---|---|
brand |
string | no | Brand slug. Optional in JWT mode. |
date |
string | yes | The date to revert, YYYY-MM-DD. |
idempotencyKey |
string | no |