Schedule — write
add_shift write
Section titled “add_shift ”Add a service shift to the schedule — this is what opens the restaurant for reservations. Use when an owner says ‘we do dinner Tuesday to Sunday, 5pm to 10pm’ or ‘add a lunch shift’. Give it a name, the weekdays, and start/end times; turn time (how long a table is held) defaults to 90 min. Without a shift, the AI can’t take bookings for those hours.
Required scope: schedule.write
| Parameter | Type | Required | Description |
|---|---|---|---|
brand |
string | no | Brand slug. Optional in JWT mode. |
name |
string | yes | Shift name, e.g. “Dinner” or “Lunch”. |
days |
array | yes | Weekdays the shift runs, as 3-letter codes: Sun, Mon, Tue, Wed, Thu, Fri, Sat. |
startTime |
string | yes | Start time, 24h HH:MM (e.g. “17:00”). |
endTime |
string | yes | End time, 24h HH:MM (e.g. “22:00”). |
turnMinutes |
number | no | How long a table is held per booking, in minutes. Default 90. |
maxCoversPerSlot |
number | no | Max guests that can be seated per time slot. Default 20. |
slotInterval |
union | no | Booking time granularity in minutes (15 or 30). Default 30. |
color |
string | no | Optional hex colour for the dashboard calendar (e.g. “#2563EB”). |
idempotencyKey |
string | no |
remove_shift write
Section titled “remove_shift ”Remove a service shift by its name (e.g. ‘Lunch’) or id. Use when an owner drops a service. If the shift has upcoming reservations, the removal is blocked with an explanation so nothing is silently cancelled.
Required scope: schedule.write
| Parameter | Type | Required | Description |
|---|---|---|---|
brand |
string | no | Brand slug. Optional in JWT mode. |
shift |
string | yes | Shift name (e.g. “Lunch”) or 24-char shift id. |
idempotencyKey |
string | no |