---
search:
  tags:
    - User groups
    - PATCH
seo:
  description: >-
    Partially updates a user group. Scoped to your integration's institution
    via… Reference for the PATCH /users/user-groups/{id} endpoint in the Fuxam
    API v4.
sidebar:
  label: Update a user group
  badge: PATCH
title: Update a user group
type: openapi-operation
---
Partially updates a user group. Scoped to your integration's institution via Basic Auth credentials.

`PATCH /users/user-groups/{id}`

**Request body** (`application/json`, required)

- `name` (string)
- `code` (string)
- `color` (string)
- `additionalInformation` (string)
- `status` (string)

Request body example:

```json
{
  "name": "string",
  "code": "string",
  "color": "string",
  "additionalInformation": "string",
  "status": "ACTIVE"
}
```

**Responses**

- `200` — Updated group
- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `429` — Too Many Requests — 1000 requests per minute per institution. Includes \`X-RateLimit-Limit\`, \`X-RateLimit-Remaining\`, \`X-RateLimit-Reset\` (ISO-8601), and \`Retry-After\` (seconds).
- `500` — Internal Server Error

Response example, 200:

```json
{
  "data": {
    "id": "string",
    "name": "string",
    "institutionId": "string",
    "code": "string",
    "color": "string",
    "additionalInformation": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "status": "ACTIVE"
  },
  "meta": {
    "requestId": "req_1234567890_abc",
    "timestamp": "2026-06-02T07:00:00.000Z",
    "version": "v4",
    "watermark": "2019-08-24T14:15:22Z"
  }
}
```
