> 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/how-the-apps-work/screens/rooms/area-info.md).

# Area info

{% 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)). Platforms: iOS and Android. [Source on GitHub](https://github.com/snapfix/docs/blob/main/spec/screens/rooms/area-info.md).
{% endhint %}

An area's name, description and instructions; site admins can change them.

* **Where:** iOS: an area's task list, a tap on the header ([Area](https://docs.snapfix.com/how-the-apps-work/screens/rooms/area.md#layout)); Android: an area's task list, a tap on the header or the info icon
* **Who:** anyone who can open the area. Only site admins can edit: iOS reads the site's `parent_admin` flag and Android its `isAccountAdmin` flag; everyone else sees the same text read-only. The API's area edit accepts any site member.
* **Feature:** [Rooms and areas](https://docs.snapfix.com/product/features/rooms/rooms-and-areas.md)

The web has no area info screen; its area edit dialog in [Areas & rooms](https://docs.snapfix.com/how-the-apps-work/screens/rooms/areas-and-rooms.md#dialogs-and-sheets) has a name and a description but no instructions \[[ASK-86](https://github.com/snapfix/docs/blob/main/ASK.md#ask-86-should-areas-have-instructions-on-the-web)].

## Layout

**iOS:** the area's name with its description under it (hidden when the area has none), then three fields: the name, the description and the instructions. The name and description are translated when the site has translation on. Site admins see each field with a border and an edit button; others see them without borders, and can't type in them.

**Android:** a toolbar with the area's name and description, then three fields: "Area Name", "Description" and "Instructions". They are editable for site admins and disabled for everyone else.

## Inputs

| Field        | Type                | Required | Default                  | Rules and messages                                                                                                                                                          |
| ------------ | ------------------- | -------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Area name    | Text                | Yes      | The current name         | Trimmed; at most 255 characters on both apps. Empty: "Area Name cannot be empty". A name another area of the site already has: "Area Name already exists in this building". |
| Description  | Text, several lines | No       | The current description  | Trimmed. Android: at most 1,000 characters; iOS: no limit. Can be cleared.                                                                                                  |
| Instructions | Text, several lines | No       | The current instructions | As the description. Android doesn't save changes to instructions.                                                                                                           |

Both apps take the name messages from their string files and show them as a red message that keeps the screen open.

## Actions

| Action       | Who         | What happens                                                                                                                                                                                        | API                                                                                                                       |
| ------------ | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| Edit a field | Site admins | The field takes the change. Only changed fields are saved.                                                                                                                                          | None                                                                                                                      |
| Back         | Anyone      | Checks the name. When it passes and an admin changed something, saves the area on the device, starts the sync and closes the screen. A failed check keeps the screen open. There is no save button. | The sync: [`?action=save_pri_area`](https://docs.snapfix.com/engineering-reference/api/rooms.md#post-actionsave_pri_area) |

The apps don't use the area REST routes here. The change is stored on the device and sent by the sync, so it works offline.

## States

* **Loading:** none; the area comes from the device.
* **Empty:** the description and instructions fields are empty when the area has none.
* **Error:** an empty or duplicate name shows its red message and keeps the screen open. A failed sync isn't shown here.
* **No permission:** users who aren't site admins see the fields read-only, with no edit buttons.
* **Offline:** the edit is kept on the device and sent when the sync runs ([shared behavior](https://docs.snapfix.com/how-the-apps-work/shared.md)).

## Platform differences

| Topic             | iOS        | Android                           | Web ([Areas & rooms](https://docs.snapfix.com/how-the-apps-work/screens/rooms/areas-and-rooms.md))                      |
| ----------------- | ---------- | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| Opened from       | The header | The header or the info icon       | The "Edit" button                                                                                                       |
| Instructions      | Saved      | Shown and editable, but not saved | No field \[[ASK-86](https://github.com/snapfix/docs/blob/main/ASK.md#ask-86-should-areas-have-instructions-on-the-web)] |
| Description limit | None       | 1,000 characters                  | 255 characters                                                                                                          |


---

# 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/how-the-apps-work/screens/rooms/area-info.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.
