Sign in
Rooms

Update a room

Partially updates a Room. Every field is optional; only fields you send are written. Sending an empty availability_rules array clears the room's custom availability (server normalises it to null).

Requires the SETTINGS_MANAGE permission on the room's site.

put/shop/rooms/{roomId}

Request body

namestring

New display name for the room.

capacityinteger

New concurrent-bookings capacity. Reducing capacity below the count of active bookings doesn't kick anyone out — existing bookings keep their slot.

use_custom_opening_hoursboolean

Toggle whether the room uses its own availability_rules or the site's opening hours.

suitable_for_tagsstring[]
tag_idsstring[]
zone_idsstring[]

Example request

{
  "name": "Treatment Room 1",
  "capacity": 2,
  "availability_rules": [
    {
      "time_from": "09:00",
      "time_to": "17:00"
    }
  ]
}

Response

A single Room.

Example response

{
  "data": {
    "id": "5dcb47800000000000000000",
    "organisation_id": "0193b6e0-3b56-7000-9f50-9d3d5e2c1111",
    "site_id": "0193b6e0-3b56-7000-9f50-9d3d5e2c2222",
    "name": "Treatment Room 1",
    "capacity": 1,
    "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.