Sign in
Rooms

Update room order

Replaces the display order of the site's Rooms. The order of room_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/rooms/order

Request body

room_idsstring[] required

Ordered list of room IDs. Element 0 becomes the first-displayed room, element 1 the second, and so on.

site_idstring uuid required

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

Response

The site's rooms in display order. Used to drive a drag-and-drop ordering UI alongside the matching PUT /shop/rooms/order endpoint.

Example response

{
  "data": [
    {
      "id": "5dcb47800000000000000000"
    }
  ]
}

Changes

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