---
title: "Update group"
method: PATCH
path: "/resources/groups/v1/{id}"
tags: ["User groups"]
---

# Update group

`PATCH /resources/groups/v1/{id}`

## Request

- Base URL: `http://localhost:8181`
- URL: `http://localhost:8181/resources/groups/v1/{id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/frontegg/apis/entitlements-agent-pdp/docs/resources/groups/v1/:id/patch.ts> (a function with typed inputs; its response is checked against the schema)

This route updates user group by id for a tenant.

## Path parameters

- `id` string, required

## Request body

- UpdateGroupDto
  - `color` string: Color for group display
  - `description` string: Group description
  - `metadata` string: Stringified JSON object
  - `name` string: Group unique name

## Response `200`

- GroupResponse
  - `id` string, required
  - `name` string, required
  - `color` string, required
  - `description` string, required
  - `metadata` string, required
  - `roles` RoleDto[], required
    - `id` string, required
    - `vendorId` string, required
    - `tenantId` string, required
    - `key` string, required
    - `name` string, required
    - `description` string, required
    - `isDefault` boolean, required
    - `firstUserRole` boolean, required
    - `level` number, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `users` GroupUserDto[], required
    - `id` string, required
    - `email` string, required
    - `name` string, required
    - `profilePictureUrl` string, required
    - `createdAt` string, date-time, required
    - `activatedForTenant` boolean, required
  - `managedBy` 'frontegg' | 'scim2', required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required

---

[API](https://skmtc.dev/frontegg/apis/entitlements-agent-pdp.md) - [All operations](https://skmtc.dev/frontegg/apis/entitlements-agent-pdp/llms.txt) - [OpenAPI document](https://skmtc.dev/frontegg/apis/entitlements-agent-pdp/revisions/c496ae9e1c3e?raw)