Sign in
BookableAreas

Update a bookable area

Updates a BookableArea. The validator enforces the same shape as on create — name and capacity are required. Sending fewer fields than that returns 422.

Requires the SETTINGS_MANAGE permission on the area's site.

put/shop/bookable-areas/{bookableAreaId}

Request body

namestring required

New display name for the bookable area.

descriptionstring nullable

Replacement long-form description shown to customers on the shopfront. Markdown is rendered. Pass null to clear.

capacityinteger required

New capacity. Lowering capacity doesn't cancel existing bookings — they keep their slot.

zone_idsstring[]

Zones the area belongs to. Filtered to the area's site.

Example request

{
  "name": "Hot Tub 1",
  "description": "Heated 4-person hot tub with hydrotherapy jets, available year-round.",
  "capacity": 4
}

Response

A single BookableArea.

Example response

{
  "data": {
    "id": "5dcb47800000000000000000",
    "organisation_id": "0193b6e0-3b56-7000-9f50-9d3d5e2c1111",
    "site_id": "0193b6e0-3b56-7000-9f50-9d3d5e2c2222",
    "name": "Hot Tub 1",
    "description": "Private rooftop hot tub for up to four guests. 38°C, sunset\nviews over the gardens.\n",
    "capacity": 4,
    "availability_rules": [
      {
        "date_from": "2021-02-15",
        "date_to": "2021-02-15",
        "time_from": "11:00",
        "time_to": "17:00"
      }
    ],
    "zones": [
      {
        "id": "5f1234567890abcdef123456",
        "name": "Pool Deck",
        "organisation_id": "22222222-2222-2222-2222-222222222222",
        "site_id": "11111111-1111-1111-1111-111111111111"
      }
    ]
  }
}

Changes

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