Sign in
BlockedTimePresets

Create a blocked-time preset

Creates a new BlockedTimePreset at the given site. Only name is required; the remaining fields configure the defaults that pre-fill a BlockedTime created from this preset.

Requires the SETTINGS_MANAGE permission on the site.

post/shop/blocked-time-presets

Query parameters

site_idstring required

Filter results by the site they belong to

Request body

namestring required

Display name. Plain text only.

durationinteger

Default duration in minutes (1..1200). Defaults to the site's calendar slot duration when omitted.

type'cleaning' | 'break' | 'meeting' | 'other'

Default block type. Drives the calendar icon.

labelstring nullable

Default short label rendered on the calendar tile so staff can distinguish blocks at a glance (e.g. Lunch or Team meeting). Plain text only.

notesstring nullable

Default free-form note (plain text) shown when staff click into a block created from this preset. Useful for extra context that doesn't fit on the label.

colorstring nullable

Default hex colour override. Format #rrggbb, lower-case.

organisation_idstring uuid

Organisation that owns this preset. Defaults to the caller's default organisation. The caller must belong to the chosen organisation.

Example request

{
  "name": "Lunch break",
  "duration": 30,
  "label": "Lunch",
  "notes": "Cover the front desk with reception.",
  "color": "#ff8800"
}

Response

A single BlockedTimePreset.

Example response

{
  "data": {
    "id": "65f1234567890abcdef12345",
    "name": "Lunch break",
    "duration": 30,
    "type": "break",
    "label": "Lunch",
    "color": "#ff8800"
  }
}

Changes