> For the complete documentation index, see [llms.txt](https://docs.snapfix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snapfix.com/product/features/rooms/rooms-and-areas.md).

# Rooms and areas

{% hint style="info" %}
Draft, written by an agent and not yet checked by a person ([how to read these docs](https://docs.snapfix.com/how-to-read.md)). [Source on GitHub](https://github.com/snapfix/docs/blob/main/product/features/rooms-and-areas.md).
{% endhint %}

A **site** says where its work happens with **rooms** and **areas**, and **tasks** can be linked to them. A room is a numbered place, such as "Room 101"; an area is any other named place, such as a lobby or a car park. Site admins set them up on the web, in the Site Console tab "Areas & Rooms": they create rooms from number ranges and areas from templates, typed names or a spreadsheet, and rename or delete both. Everyone on the site sees the rooms and areas with their task counts and opens one to work on its tasks. In the mobile apps, people read a room's or an area's info, and site admins can edit it there. A room also has a status and a priority, described in [Room status](https://docs.snapfix.com/product/features/rooms/room-status.md).

## Rules

### What rooms and areas are

* Rooms and areas are two flat lists per site. A room does not belong to an area ([`tPri_Room`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_room.md), [`tPri_Area`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_area.md)).
* Both are kept in the site's **building**. The first room or area a site gets also creates the building, with its default room sections and statuses ([`POST /v1/app/areas`](https://docs.snapfix.com/engineering-reference/api/rooms.md#post-v1appareas)).
* A room or area has a name, a description and instructions ([`PUT /v1/app/rooms/{uuid}`](https://docs.snapfix.com/engineering-reference/api/rooms.md#put-v1approomsuuid)).
* A task links to at most one room and one area; linking a new one replaces the old one. Adding a room also marks the task pending \[[ASK-16](https://github.com/snapfix/docs/blob/main/ASK.md#ask-16-should-adding-a-room-to-a-task-always-mark-it-pending)] ([`POST /v1/app/tasks/room-add`](https://docs.snapfix.com/engineering-reference/api/tasks.md#post-v1apptasksroom-add), [`POST /v1/app/tasks/area-add`](https://docs.snapfix.com/engineering-reference/api/tasks.md#post-v1apptasksarea-add)).
* A group can require every new task to have a room, an area, or either ([Group settings](https://docs.snapfix.com/how-the-apps-work/screens/groups/group-settings.md#settings-drawer-web)). The web and the apps check it when a person creates a task; the server accepts a task without one, and planned tasks are not checked \[[ASK-59](https://github.com/snapfix/docs/blob/main/ASK.md#ask-59-should-a-groups-task-requirements-apply-to-planned-tasks)].
* No plan limit applies to rooms or areas \[[ASK-85](https://github.com/snapfix/docs/blob/main/ASK.md#ask-85-is-room-status-a-paid-feature)].

### Who can do what

* Every signed-in member of the site sees every room and area. No role is checked for the lists, and there is no per-room permission ([Room tasks](https://docs.snapfix.com/how-the-apps-work/screens/rooms/room-tasks.md), [Areas](https://docs.snapfix.com/how-the-apps-work/screens/rooms/areas.md)).
* A room's or an area's task counts cover only the tasks the user can see ([room object](https://docs.snapfix.com/engineering-reference/api/rooms.md#room-object)).
* On the web, only the site role "Admin" creates, edits and deletes. The "Areas & Rooms" tab shows only for that role; a group admin can still open the page by its address and then sees only the list, and the page's guard checks the selected site, not the one in the address ([Areas & rooms](https://docs.snapfix.com/how-the-apps-work/screens/rooms/areas-and-rooms.md)).
* In the apps, anyone reads a room's or an area's info; only site admins can edit it ([Room info](https://docs.snapfix.com/how-the-apps-work/screens/rooms/room-info.md), [Area info](https://docs.snapfix.com/how-the-apps-work/screens/rooms/area-info.md)).
* The API is looser than the screens. Reads check only the sign-in, so anyone signed in can read any site's rooms and areas by ID. Creating, renaming and deleting one room or area needs only membership of the site, any role; only the bulk deletes need a site admin. Who should be allowed is open \[[ASK-81](https://github.com/snapfix/docs/blob/main/ASK.md#ask-81-who-may-create-rename-and-delete-rooms-and-areas-and-change-their-priority-and-status)] ([Room and area permissions](https://docs.snapfix.com/engineering-reference/api/rooms.md#room-and-area-permissions)).

### Creating

* On the web, rooms are created only from number ranges: "From" and "To" generate every number in between, at most 500 per range, and "From" cannot be above "To". The dialog takes at most 1,000 staged rooms, counting only the rooms staged in it, not the site's rooms. A room can be given another name later, in its edit dialog ([Create rooms](https://docs.snapfix.com/how-the-apps-work/screens/rooms/areas-and-rooms.md#create-rooms)).
* Areas are created from five templates ("Ballroom", "Bar", "Business Centre", "Cafe" and "Car Park"), from typed names, or from an .xlsx file with an "Area Name" column of up to 10,000 names ([Create Areas](https://docs.snapfix.com/how-the-apps-work/screens/rooms/areas-and-rooms.md#create-areas), [`GET /v1/app/areas/templates/list`](https://docs.snapfix.com/engineering-reference/api/rooms.md#get-v1appareastemplateslist)). Edits to the uploaded names are ignored.
* Names the site already has are skipped, and nothing says so. Areas are compared ignoring case. Rooms are looked up ignoring case but compared exactly, so a room name that differs only by case is created as a second room. A create in which every name is taken is refused ([`POST /v1/app/rooms`](https://docs.snapfix.com/engineering-reference/api/rooms.md#post-v1approoms), [`POST /v1/app/areas`](https://docs.snapfix.com/engineering-reference/api/rooms.md#post-v1appareas)).

### Editing

* A rename to a name another room or area of the site has, ignoring case, is refused with "The name has already been taken." ([`PUT /v1/app/rooms/{uuid}`](https://docs.snapfix.com/engineering-reference/api/rooms.md#put-v1approomsuuid)).
* The web edits a room's number, description and instructions, and an area's name and description; it has no field for area instructions \[[ASK-86](https://github.com/snapfix/docs/blob/main/ASK.md#ask-86-should-areas-have-instructions-on-the-web)]. The apps edit the name, description and instructions of both ([Areas & rooms](https://docs.snapfix.com/how-the-apps-work/screens/rooms/areas-and-rooms.md#inputs), [Room info](https://docs.snapfix.com/how-the-apps-work/screens/rooms/room-info.md#inputs), [Area info](https://docs.snapfix.com/how-the-apps-work/screens/rooms/area-info.md#inputs)).
* Length limits differ by platform. A room name takes 10 characters on the web and Android and 5 on iOS; an area name takes 255 everywhere; descriptions and instructions take 255 characters on the web and 1,000 on Android. The API sets no length limit ([`PUT /v1/app/rooms/{uuid}`](https://docs.snapfix.com/engineering-reference/api/rooms.md#put-v1approomsuuid)).
* "Save" stays off while a room number or an area name is empty. A name of only spaces passes the form, and the server refuses it ([Areas & rooms](https://docs.snapfix.com/how-the-apps-work/screens/rooms/areas-and-rooms.md#inputs)).
* The apps save an edit on the device and send it with the sync, so it works offline ([Room info](https://docs.snapfix.com/how-the-apps-work/screens/rooms/room-info.md#actions)).

### Deleting

* The web asks before deleting one room or area, then selects a neighbouring one. "Select Rooms" or "Select Areas" deletes several at once ([Areas & rooms](https://docs.snapfix.com/how-the-apps-work/screens/rooms/areas-and-rooms.md#actions)).
* A delete is soft: the room or area leaves the lists and details, and its tasks keep their link ([Room and area permissions](https://docs.snapfix.com/engineering-reference/api/rooms.md#room-and-area-permissions)). There is no archive.

### Lists and counts

* The lists show each room's or area's red, amber and green task counts, and mark the ones with new task activity since the user's last visit ([Room tasks](https://docs.snapfix.com/how-the-apps-work/screens/rooms/room-tasks.md), [Areas](https://docs.snapfix.com/how-the-apps-work/screens/rooms/areas.md)). iOS never marks areas.
* On the web, leaving a room's or an area's task list after it showed new tasks records a visit, which clears the mark. That record is written by a GET request, which accepts any ID ([Room](https://docs.snapfix.com/how-the-apps-work/screens/rooms/room.md#actions)).
* The web loads the lists a page at a time from the server, searches several fields on the server and remembers the search, per site. The apps read their device copy, search it by name, and refresh it with the sync on pull-to-refresh ([Room tasks](https://docs.snapfix.com/how-the-apps-work/screens/rooms/room-tasks.md#platform-differences)).
* A room's or an area's own page is the group task list, with the room's or area's tasks that the user may see ([Room](https://docs.snapfix.com/how-the-apps-work/screens/rooms/room.md), [Area](https://docs.snapfix.com/how-the-apps-work/screens/rooms/area.md)). On a web multi-site, only site admins get its "+" and "⋯" menu.

## Flow

```mermaid
flowchart LR
  admin["Site admin, Site Console: Areas & Rooms"] --> tab{"Rooms or Areas"}
  tab --> rooms["Rooms from number ranges"]
  tab --> areas["Areas from templates, names or an .xlsx file"]
  tab --> change["Rename, or delete one or several"]
  rooms --> lists["Fix: Room Tasks and Areas, with counts"]
  areas --> lists
  lists --> open["Open a room or area: its tasks"]
  open --> work["Create or work on a task there"]
  open --> info["Apps: Room info or Area info; site admins edit, synced later"]
```

## Platforms

| Capability                           | Web                                                                            | iOS                                     | Android                                 |
| ------------------------------------ | ------------------------------------------------------------------------------ | --------------------------------------- | --------------------------------------- |
| See rooms and areas with task counts | Yes, from the server                                                           | Yes, from the device copy               | Yes, from the device copy               |
| Areas as grid or list                | Grid or list                                                                   | Table                                   | List                                    |
| Open a room's or an area's task list | Yes                                                                            | Yes                                     | Yes                                     |
| Add a task from a room or area       | Yes; site admins only on a multi-site                                          | Yes                                     | Yes                                     |
| "Mark all as read" on an area        | Fails                                                                          | Yes                                     | Yes                                     |
| Create rooms and areas               | Site admins, in the Site Console                                               | No                                      | No                                      |
| Rename and edit texts                | Site admins: room number, description, instructions; area name and description | Site admins, in Room info and Area info | Site admins, in Room info and Area info |
| Delete one or several                | Site admins                                                                    | No                                      | No                                      |
| Room info and Area info              | No                                                                             | Yes                                     | Yes                                     |
| Offline                              | No                                                                             | Yes, edits synced later                 | Yes, edits synced later                 |

## Screens

* [Room tasks](https://docs.snapfix.com/how-the-apps-work/screens/rooms/room-tasks.md): the site's rooms with their counts.
* [Room](https://docs.snapfix.com/how-the-apps-work/screens/rooms/room.md): one room's tasks.
* [Room info](https://docs.snapfix.com/how-the-apps-work/screens/rooms/room-info.md): a room's name, description and instructions, in the apps.
* [Areas](https://docs.snapfix.com/how-the-apps-work/screens/rooms/areas.md): the site's areas with their counts.
* [Area](https://docs.snapfix.com/how-the-apps-work/screens/rooms/area.md): one area's tasks.
* [Area info](https://docs.snapfix.com/how-the-apps-work/screens/rooms/area-info.md): an area's name, description and instructions, in the apps.
* [Areas & rooms](https://docs.snapfix.com/how-the-apps-work/screens/rooms/areas-and-rooms.md): the Site Console page where site admins create, edit and delete.

## API and data

* [Rooms API](https://docs.snapfix.com/engineering-reference/api/rooms.md):
  * Lists: [`POST /v1/app/rooms/list`](https://docs.snapfix.com/engineering-reference/api/rooms.md#post-v1approomslist) and [`POST /v1/app/areas/list`](https://docs.snapfix.com/engineering-reference/api/rooms.md#post-v1appareaslist), with the new-activity counts [`POST /v1/app/rooms/get-updates`](https://docs.snapfix.com/engineering-reference/api/rooms.md#post-v1approomsget-updates) and [`POST /v1/app/areas/get-updates`](https://docs.snapfix.com/engineering-reference/api/rooms.md#post-v1appareasget-updates), and the visit records [`GET /v1/app/rooms/mark-as-visited/{roomUuid}`](https://docs.snapfix.com/engineering-reference/api/rooms.md#get-v1approomsmark-as-visitedroomuuid) and [`GET /v1/app/areas/mark-as-visited/{areaUuid}`](https://docs.snapfix.com/engineering-reference/api/rooms.md#get-v1appareasmark-as-visitedareauuid).
  * One room or area: [`GET /v1/app/rooms/{uuid}`](https://docs.snapfix.com/engineering-reference/api/rooms.md#get-v1approomsuuid) and [`GET /v1/app/areas/{uuid}`](https://docs.snapfix.com/engineering-reference/api/rooms.md#get-v1appareasuuid).
  * Creating: [`POST /v1/app/rooms`](https://docs.snapfix.com/engineering-reference/api/rooms.md#post-v1approoms), [`POST /v1/app/areas`](https://docs.snapfix.com/engineering-reference/api/rooms.md#post-v1appareas) and the [area templates](https://docs.snapfix.com/engineering-reference/api/rooms.md#get-v1appareastemplateslist).
  * Changing and deleting: [`PUT /v1/app/rooms/{uuid}`](https://docs.snapfix.com/engineering-reference/api/rooms.md#put-v1approomsuuid), [`PUT /v1/app/areas/{uuid}`](https://docs.snapfix.com/engineering-reference/api/rooms.md#put-v1appareasuuid), [`DELETE /v1/app/rooms/{uuid}`](https://docs.snapfix.com/engineering-reference/api/rooms.md#delete-v1approomsuuid), [`DELETE /v1/app/areas/{uuid}`](https://docs.snapfix.com/engineering-reference/api/rooms.md#delete-v1appareasuuid), [`POST /v1/app/rooms/delete/multi`](https://docs.snapfix.com/engineering-reference/api/rooms.md#post-v1approomsdeletemulti) and [`POST /v1/app/areas/delete/multi`](https://docs.snapfix.com/engineering-reference/api/rooms.md#post-v1appareasdeletemulti).
  * The groups and tasks of a room or area, for the Site Console page: [`GET /v1/app/rooms/{uuid}/businesses`](https://docs.snapfix.com/engineering-reference/api/rooms.md#get-v1approomsuuidbusinesses), [`GET /v1/app/rooms/{uuid}/business/{businessUuid}/jobs`](https://docs.snapfix.com/engineering-reference/api/rooms.md#get-v1approomsuuidbusinessbusinessuuidjobs) and the area versions.
  * The apps' download and sync: [`?action=read_parent_room_data`](https://docs.snapfix.com/engineering-reference/api/rooms.md#post-actionread_parent_room_data), [`?action=read_parent_area_data`](https://docs.snapfix.com/engineering-reference/api/rooms.md#post-actionread_parent_area_data), [`?action=save_pri_room`](https://docs.snapfix.com/engineering-reference/api/rooms.md#post-actionsave_pri_room) and [`?action=save_pri_area`](https://docs.snapfix.com/engineering-reference/api/rooms.md#post-actionsave_pri_area).
* [Tasks API](https://docs.snapfix.com/engineering-reference/api/tasks.md): the room and area task lists read [`POST /v1/app/tasks/list`](https://docs.snapfix.com/engineering-reference/api/tasks.md#post-v1apptaskslist) with the room or area; tasks are linked with `room-add`, `room-remove`, `area-add` and `area-remove`.
* Tables: [`tPri_Room`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_room.md), [`tPri_Area`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_area.md), [`tPri_Building`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_building.md) with its sections [`tPri_BuildingRoomSection`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_buildingroomsection.md), [`tPri_JobRoom`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_jobroom.md) and [`tPri_JobArea`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_jobarea.md) (the task links), and [`tPri_Log_RoomViewedUser`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_log_roomvieweduser.md) and [`tPri_Log_AreaViewedUser`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_log_areavieweduser.md) (the visits behind the marks).

## Depends on

* [Tasks](https://docs.snapfix.com/product/features/tasks/tasks.md), [Task lists](https://docs.snapfix.com/product/features/tasks/task-lists.md) and [Creating tasks](https://docs.snapfix.com/product/features/tasks/task-creation.md): a room's or area's page is a task list, and its "+" starts a task with the room or area set.
* [Groups](https://docs.snapfix.com/product/features/groups/groups.md) and [Group members](https://docs.snapfix.com/product/features/groups/group-members.md): site membership decides who may change rooms on the server, and a group setting can require a room or area on tasks.
* [Room status](https://docs.snapfix.com/product/features/rooms/room-status.md): each room's status and priority, on the same Rooms tab.
* [Cleaning tasks](https://docs.snapfix.com/product/features/housekeeping/cleaning-tasks.md) and [Inspections](https://docs.snapfix.com/product/features/housekeeping/inspections.md): housekeeping cleans and inspects rooms; the housekeeping create form takes a room's groups from its status rule.
* [Planned tasks](https://docs.snapfix.com/product/features/planner/planned-tasks.md): the room and area pickers of planners.
* [PMS integrations](https://docs.snapfix.com/product/features/integrations/pms-integrations.md): room types and guest stays come from the property management system, whose room mappings point at rooms.
* [Snapfix AI](https://docs.snapfix.com/product/features/ai/snapfix-ai.md): the assistant searches rooms and areas by name.
* [Switching sites](https://docs.snapfix.com/product/features/groups/site-switching.md): the lists follow the selected site.

## Edge cases

* **Empty site:** a site with no rooms or areas shows a welcome placeholder, not an error. A site with no building gets empty lists; the first room or area creates the building ([Room tasks](https://docs.snapfix.com/how-the-apps-work/screens/rooms/room-tasks.md#states)).
* **Failed list (web):** the tab reads "Room Tasks (Undefined)" or "Areas (Undefined)" and the welcome placeholder shows, as if the site had none. A search with no match shows the same placeholder.
* **Deleted room or area:** it leaves the lists, and the apps drop it after their next sync. On the web, a room or area page that can't load goes to Fix ([Room](https://docs.snapfix.com/how-the-apps-work/screens/rooms/room.md#states)).
* **Duplicate names:** see [Creating](#creating) and [Editing](#editing). The iOS duplicate check misses most names, and the duplicate is then saved.
* **Offline:** the apps show their device copy and send info edits with the next sync; the web needs a connection ([Room info](https://docs.snapfix.com/how-the-apps-work/screens/rooms/room-info.md#states)).
* **Several sites:** each room and area belongs to one site, and the lists follow the selected site. Reads by ID don't check the site.
* **Time zones:** room cards show the last change as "MMM DD, HH:mm"; the screen docs name no time zone ([Room tasks](https://docs.snapfix.com/how-the-apps-work/screens/rooms/room-tasks.md#layout)).
* **iOS tasks from a room or area:** they skip the group's required tag folders.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.snapfix.com/product/features/rooms/rooms-and-areas.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
