> 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/console/multi-site-console.md).

# Multi-Site Console

{% 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/multi-site-console.md).
{% endhint %}

A **multi-site** groups several **sites** of one customer. With the multi-site picked in the site switcher, a **multi-site user** opens the **Multi-Site Console**, a web page with four tabs: "My Sites", "Site Details", "Users" and "Checklists". There people see the multi-site's sites and open any of them, change the multi-site's name, description and image, edit each site's details, manage the users of all its sites, and manage checklist templates for the multi-site and its sites. Adding or removing a site goes through Snapfix Customer Success, and the link to their form is broken. The apps have no console; their site switcher lists the sites one at a time.

## Rules

### Access

* The console opens only while a multi-site is selected in the site switcher; otherwise it goes to `/fix` ([My sites](https://docs.snapfix.com/how-the-apps-work/screens/console/my-sites.md)).
* A multi-site user is a person in the multi-site's user list. There is no multi-site admin role: no code reads the admin flag, so every multi-site user gets every control, and the server checks only the membership \[[ASK-123](https://github.com/snapfix/docs/blob/main/ASK.md#ask-123-who-may-manage-a-multi-site-and-change-its-members-site-roles)] ([Roles](https://docs.snapfix.com/engineering-reference/api/console.md#roles)).
* The server does not check that the sites named in a role change belong to the multi-site, so a multi-site user can make anyone, themselves included, an admin of any site, or remove anyone from any site ([`POST /multisite/{multisiteUUID}/user/{userUUID}`](https://docs.snapfix.com/engineering-reference/api/console.md#post-multisitemultisiteuuiduseruseruuid)).

### My Sites

* The page lists the multi-site's sites, without churned ones, each with its red, amber and green task counts; a count of 100,000 or more shows "99999+" ([My sites](https://docs.snapfix.com/how-the-apps-work/screens/console/my-sites.md#layout), [`GET /v1/app/multiSites/{uuid}`](https://docs.snapfix.com/engineering-reference/api/console.md#get-v1appmultisitesuuid)).
* Opening a site makes it the stored current site and opens Fix, while the multi-site stays selected in the switcher \[[ASK-137](https://github.com/snapfix/docs/blob/main/ASK.md#ask-137-after-a-site-card-is-opened-on-my-sites-should-the-site-menu-show-that-site)] ([My sites](https://docs.snapfix.com/how-the-apps-work/screens/console/my-sites.md#actions)).
* The multi-site's name is required and holds up to 100 characters; its description holds up to 255 ([My sites](https://docs.snapfix.com/how-the-apps-work/screens/console/my-sites.md#inputs)).
* "Add Site" and "Delete Site" only point to Customer Success; their support page returns 404 ([My sites](https://docs.snapfix.com/how-the-apps-work/screens/console/my-sites.md#dialogs-and-sheets)).

### Site Details

* The form is [Site details](https://docs.snapfix.com/product/features/console/site-details.md) for a site picked in the card. It is editable only where the user is a site admin ([Site details (multi-site)](https://docs.snapfix.com/how-the-apps-work/screens/console/multi-site-details.md)).
* Any click on the form card, by a user who is not a site admin of that site, opens "Site Admin Permission"; "Yes" makes the user a site admin of it ([Site details (multi-site)](https://docs.snapfix.com/how-the-apps-work/screens/console/multi-site-details.md#dialogs-and-sheets)).
* Opened directly or reloaded, the tab stays blank ([Site details (multi-site)](https://docs.snapfix.com/how-the-apps-work/screens/console/multi-site-details.md)).

### Users

* "Make a Multi-site Admin" adds or removes the multi-site membership, after a popup. It sets a plain membership, which the popup calls the "Multi-site view role" ([Users (multi-site)](https://docs.snapfix.com/how-the-apps-work/screens/console/multi-site-users.md#inputs)).
* A multi-site user's site roles are "Multi-site View" or "Site Admin"; anyone else's are "User" or "Site Admin". Group roles are "Group Admin" with "Multi-site View" or "User" ([Users (multi-site)](https://docs.snapfix.com/how-the-apps-work/screens/console/multi-site-users.md#inputs)).
* Removing the membership also removes the user's site rows on the multi-site's sites, except site admin rows, which stay \[[ASK-127](https://github.com/snapfix/docs/blob/main/ASK.md#ask-127-should-removing-a-user-from-a-multi-site-also-remove-the-site-admin-roles-it-gave)] ([`DELETE /multisite/{multisiteUUID}/user/{userUUID}`](https://docs.snapfix.com/engineering-reference/api/console.md#delete-multisitemultisiteuuiduseruseruuid)). Removing a user from some sites leaves the membership.
* The Groups tab offers only the sites saved on the Sites tab. The signed-in user cannot change their own sites ([Users (multi-site)](https://docs.snapfix.com/how-the-apps-work/screens/console/multi-site-users.md#inputs)).
* The pages match sites by name, so two sites with the same name share one checkbox, one role and one role entry.

### Checklists

* The tab manages templates for the whole multi-site or for one of its sites, with a Sites tab and "Set as Multisite", which makes a site template a multi-site one. A site of the multi-site picks multi-site templates through "Pick from templates" ([Checklists](https://docs.snapfix.com/how-the-apps-work/screens/console/checklists.md), [Checklist templates](https://docs.snapfix.com/product/features/checklists/checklist-templates.md)).

## Flow

```mermaid
flowchart TD
    pick["Pick the multi-site in the site switcher"] --> console["Multi-Site Console"]
    console --> mysites["My Sites: cards, search, edit the multi-site"]
    mysites --> open["Open a site: it becomes current, Fix opens"]
    mysites --> addsite["Add or delete a site: contact Customer Success"]
    console --> details["Site Details: pick a site"]
    details --> admin{"Site admin there?"}
    admin -- no --> prompt["Site Admin Permission: Yes makes you one"]
    admin -- yes --> edit["Edit and Save"]
    prompt --> edit
    console --> users["Users: membership, site roles, groups, devices"]
    console --> lists["Checklists: multi-site and site templates"]
```

## Platforms

| Capability                                  | Web                                                       | iOS                                        | Android                                    |
| ------------------------------------------- | --------------------------------------------------------- | ------------------------------------------ | ------------------------------------------ |
| Multi-Site Console                          | Yes, for multi-site users                                 | No                                         | No                                         |
| See the multi-site's sites with task counts | My Sites                                                  | No; the switcher lists sites one at a time | No; the switcher lists sites one at a time |
| Edit a site's details                       | Any site of the multi-site where the user is a site admin | The current site only                      | The current site only                      |
| Multi-site membership and site roles        | Yes                                                       | No                                         | No                                         |
| Multi-site checklist templates              | Yes                                                       | No                                         | No                                         |
| Add or delete a site                        | Through Customer Success                                  | No                                         | No                                         |

## Screens

* [My sites](https://docs.snapfix.com/how-the-apps-work/screens/console/my-sites.md): the sites, the multi-site's details and the Add and Delete popups.
* [Site details (multi-site)](https://docs.snapfix.com/how-the-apps-work/screens/console/multi-site-details.md): the form for a picked site.
* [Users (multi-site)](https://docs.snapfix.com/how-the-apps-work/screens/console/multi-site-users.md): membership, site roles, groups and devices.
* [Checklists](https://docs.snapfix.com/how-the-apps-work/screens/console/checklists.md): templates for the multi-site and its sites.

## API and data

* [`GET /v1/app/multiSites/{uuid}`](https://docs.snapfix.com/engineering-reference/api/console.md#get-v1appmultisitesuuid): the sites with their task counts and the caller's role on each.
* [`PUT /multisite/{multisiteUUID}`](https://docs.snapfix.com/engineering-reference/api/console.md#put-multisitemultisiteuuid): the multi-site's name, description and image.
* [`GET /multisite/{multisiteUUID}/users`](https://docs.snapfix.com/engineering-reference/api/console.md#get-multisitemultisiteuuidusers): the users of its sites, 50 at a time.
* [`GET /multisite/{multisiteUUID}/user/{userUUID}/sites`](https://docs.snapfix.com/engineering-reference/api/console.md#get-multisitemultisiteuuiduseruseruuidsites): a person's role on each site.
* [`POST /multisite/{multisiteUUID}/user/{userUUID}`](https://docs.snapfix.com/engineering-reference/api/console.md#post-multisitemultisiteuuiduseruseruuid) and [`DELETE /multisite/{multisiteUUID}/user/{userUUID}`](https://docs.snapfix.com/engineering-reference/api/console.md#delete-multisitemultisiteuuiduseruseruuid): add or remove a membership, and set or remove site roles.
* [`GET /v1/app/parents/{uuid}`](https://docs.snapfix.com/engineering-reference/api/console.md#get-v1appparentsuuid) and [`PUT /v1/app/parents/{uuid}`](https://docs.snapfix.com/engineering-reference/api/console.md#put-v1appparentsuuid): a site's details ([Site details](https://docs.snapfix.com/product/features/console/site-details.md)).
* The checklist calls are in the [Checklists API](https://docs.snapfix.com/engineering-reference/api/checklists.md).
* Tables: [`tPri_MultiSite`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_multisite.md) (the multi-site), [`tPri_MultiSiteParent`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_multisiteparent.md) (its sites) and [`tPri_MultiSiteUser`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_multisiteuser.md) (its users).

## Depends on

* [Switching sites](https://docs.snapfix.com/product/features/groups/site-switching.md): the switcher picks the multi-site, and opening a site switches to it.
* [Site details](https://docs.snapfix.com/product/features/console/site-details.md) and [Site users](https://docs.snapfix.com/product/features/console/site-users.md): the forms and lists the console reuses.
* [Checklist templates](https://docs.snapfix.com/product/features/checklists/checklist-templates.md): the multi-site and site templates.
* [Site reports](https://docs.snapfix.com/product/features/reports/site-reports.md): "Multi-Site Reports", one site of the multi-site at a time.

## Edge cases

* **No sites in the multi-site:** My Sites shows a blank list, and Site Details nothing under the tabs ([My sites](https://docs.snapfix.com/how-the-apps-work/screens/console/my-sites.md#states)).
* **Search matches nothing:** "No sites found" and "Try a different search term or clear the filter." ([My sites](https://docs.snapfix.com/how-the-apps-work/screens/console/my-sites.md#states)).
* **A failed membership change:** the API's message shows and the checkbox goes back ([Users (multi-site)](https://docs.snapfix.com/how-the-apps-work/screens/console/multi-site-users.md#states)).
* **Invited users:** the "Invited" tab lists the invitations of the site stored as current only, and does not name it.
* **After opening a site:** the stored site reports the user's tag and checklist permissions as off until the site list reloads.
* **Welcome popup:** "Welcome to your Multi-Site Console!" shows once per browser session ([My sites](https://docs.snapfix.com/how-the-apps-work/screens/console/my-sites.md#layout)).


---

# 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/console/multi-site-console.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.
