---
title: "Patch User Group"
method: PATCH
path: "/api/v2/core/user-groups/{userGroupId}"
tags: ["User Groups"]
---

# Patch User Group

`PATCH /api/v2/core/user-groups/{userGroupId}`

## Request

- Base URL: `https://apiv2.eightfold.ai`
- URL: `https://apiv2.eightfold.ai/api/v2/core/user-groups/{userGroupId}`
- Auth: none declared. Required headers: `Authorization`
- TypeScript: <https://skmtc.dev/eightfold/apis/api-server-v2-service-service/docs/api/v2/core/user-groups/:userGroupId/patch.ts> (a function with typed inputs; its response is checked against the schema)

Updates a user group. Send only the fields to change; anything omitted is left untouched. Access criteria and dynamic membership rules cannot be set through this API. Renaming a group changes what the SCIM APIs report for it, since those identify a group by name.

## Path parameters

- `userGroupId` string, required

## Query parameters

- `exclude` string
- `keyList` string

## Headers

- `Authorization` string, required

## Request body

- UserGroupPatchSchema
  - `createdAt` integer, nullable: Create timestamp of the user group
  - `id` integer, nullable: Id of the user group
  - `isActive` boolean: Whether the user group is active
  - `description` string, nullable: Description of the user group
  - `productLine` string, nullable: Product line this user group applies to. Defaults to all product lines
  - `updatedAt` integer, nullable: Update timestamp of the user group
  - `role` string, nullable: Role granted to the members of the user group
  - `userGroupName` string, nullable: Name of the user group

## Response `200`

OK

- UserGroupBaseSchema
  - `createdAt` integer, nullable: Create timestamp of the user group
  - `id` integer, nullable: Id of the user group
  - `isActive` boolean, nullable: Whether the user group is active
  - `description` string, nullable: Description of the user group
  - `productLine` string, nullable: Product line this user group applies to. Defaults to all product lines
  - `updatedAt` integer, nullable: Update timestamp of the user group
  - `role` string, nullable: Role granted to the members of the user group
  - `userGroupName` string, nullable: Name of the user group

## Changes

- **2026-11-03** `9a8b3a927e93`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/changes/api/v2/core/user-groups/:userGroupId/patch.md)

---

[API](https://skmtc.dev/eightfold/apis/api-server-v2-service-service.md) - [All operations](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/llms.txt) - [OpenAPI document](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/revisions/9a8b3a927e93?raw)