Sign in
BookableAreas

Update bookable area order

Replaces the display order of the site's BookableAreas. The order of area_ids in the body is the new order — element 0 becomes order=0, element 1 becomes order=1, and so on.

Requires the SETTINGS_MANAGE permission on the site.

put/shop/bookable-areas/order

Request body

area_idsstring[] required

Ordered list of bookable area IDs. Element 0 becomes the first-displayed area.

site_idstring uuid required

ID of the site whose area order is being updated. The caller's API key must have access to this site.

Response

The site's bookable areas in display order. Pair with PUT /shop/bookable-areas/order to power a drag-and-drop UI.

Example response

{
  "data": [
    {
      "name": "Hot Tub 1"
    }
  ]
}

Changes