Sign in
BlockedTimePresets

Update a blocked-time preset

Updates an existing BlockedTimePreset. name is required; other fields fall back to their existing values when omitted.

Requires the SETTINGS_MANAGE permission on the preset's site.

put/shop/blocked-time-presets/{blockedTimePresetId}

Request body

namestring required

Display name. Plain text only.

durationinteger

Default duration in minutes (1..1200).

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

Default block type used when a new blocked-time is created from this preset. Drives the calendar icon and the reporting category.

labelstring nullable

Default short label rendered on the calendar tile so staff can distinguish blocks at a glance. Plain text only.

notesstring nullable

Default free-form note (plain text) shown when staff click into a block created from this preset.

colorstring nullable

Default hex colour (#rrggbb).

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

No recorded changes to this endpoint across all 1 revision of this API.