---
title: "Update a group"
method: PUT
path: "/groups/{groupId}"
tags: ["groups"]
---

# Update a group

`PUT /groups/{groupId}`

## Path parameters

- `groupId` string, required

## Request body

- GroupRequestUpdate
  - `facilities` string[] — The IDs of the facilities associated with this group.
  - `users` string[] — DEPRECATED. Do not use this field. See the "User" resource and use its "groups" array instead.
  - `name` string — Descriptive label of a group. This is the only way to link a group in Luma with another in an external service, as the group doesn't have an "externalId" field.
  - `type` 'user' | 'system' — Indicates if a group was created by users or by the system.

## Response `200`

Group

- GroupResponse — A Group is a named collection of users and/or facilities within a Luma Health account, used to organize staff for tasks like routing and assignment. Groups can be created manually by an admin or generated automatically by the system, and each one can be scoped to all facilities or a specific subset. Other resources, such as chat activities, reference a Group when work needs to be routed to a whole team rather than a single staff member.
  - `_id` string — Luma's internal ID of an object.
  - `user` string — The ID of the root account user.
  - `deleted` 0 | 1 — Flag for logical deletion where 1 means deleted.
  - `createdBy` string — The ID of the user who created this object.
  - `updatedBy` string — The ID of the user who updated this object.
  - `createdAt` string, date-time — The date/time when this object was created.
  - `updatedAt` string, date-time — The date/time when this object was updated.
  - `facilities` string[] — The IDs of the facilities associated with this group.
  - `users` string[] — DEPRECATED. Do not use this field. See the User resource and its "groups" property instead.
  - `type` 'user' | 'system' — Indicates if a group was created by users or by the system.
  - `name` string — Descriptive label of a group. This is the only way to link a group in Luma with another in an external service, as the group doesn't have an "externalId" field.

## Other responses

- `401` — Not authenticated
- `403` — Access token does not have the required scope

---

[API](https://skmtc.net/lumahealth/apis/rest-service.md) · [All operations](https://skmtc.net/lumahealth/apis/rest-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lumahealth/rest-service/revisions/d3c75c2a2f1d/schema)