---
title: "Patch Group"
method: PATCH
path: "/Groups/{id}"
tags: ["Groups"]
---

# Patch Group

`PATCH /Groups/{id}`

Use this endpoint to update one or more attributes of a group.

## Path parameters

- `id` integer, required

## Query parameters

- `attributes` string
- `excludedAttributes` string

## Request body

- PatchOpRequest — Represents a patch request.
  - `schemas` string[] — A schema for representing the patch request.
  - `Operations` object[] — A list of operations, whose value is an array of one or more patch operations.
    - `op` 'add' | 'remove' | 'replace', required — Indicates the operation to perform.
    - `path` string — Indicates an attribute path describing the target of the operation.
    - `value` unknown

## Response `201`

Returns the updated group, optionally filtered by values in attributes or excludedAttributes parameters.

- Group — Represents a group.
  - `displayName` string — A human-readable name for the Group.
  - `externalId` string, nullable — A custom, user-supplied ID.
  - `id` string — The ID of this resource instance.
  - `members` object[] — A list of members of the Group.
    - `type` string — The name of the resource type of the resource. Always 'User'.
    - `value` string — The ID of the user.
    - `x-ref` string — The URI of the corresponding 'User' resource.
    - `display` string, nullable — Compatibility field, accepted but discarded.
  - `meta` object, nullable — An object containing group metadata properties.
    - `created` string, datetime — The time when the group was created.
    - `lastModified` string, datetime — The time when the group was last modified.
    - `location` string — The URI of the group being returned.
    - `resourceType` string — The name of the resource type of the resource. Always 'Group'.
  - `schemas` string[] — A schema for representing the group's configuration.

## Other responses

- `400` — Invalid format or content of the request.
- `401` — The SCIM token is invalid.
- `404` — A required entity is missing.
- `409` — A conflict occurred with the current state of the target resource.

---

[API](https://skmtc.net/oneflow/apis/public-api-for-oneflow.md) · [All operations](https://skmtc.net/oneflow/apis/public-api-for-oneflow/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/oneflow/public-api-for-oneflow/versions/0e73a45dec15/schema)