---
title: "Put UserGroup entity"
method: PUT
path: "/api/v1/entities/userGroups/{id}"
tags: ["UserGroups - Entity APIs"]
---

# Put UserGroup entity

`PUT /api/v1/entities/userGroups/{id}`

## Request

- Base URL: `https://www.gooddata.ai`
- URL: `https://www.gooddata.ai/api/v1/entities/userGroups/{id}`
- Auth: none declared

User Group - creates tree-like structure for categorizing users

## Path parameters

- `id` string, required

## Query parameters

- `filter` string
- `include` string[]

## Request body

- JsonApiUserGroupInDocument
  - `data` JsonApiUserGroupIn, required: JSON:API representation of userGroup entity.
    - `attributes` object
      - `name` string
    - `id` string, required: API identifier of an object
    - `relationships` object
      - `parents` object
        - `data` JsonApiUserGroupLinkage[], required: References to other resource objects in a to-many (\"relationship\"). Relationships can be specified by including a member in a resource's links object.
          - `id` string, required
          - `type` 'userGroup', required
    - `type` 'userGroup', required: Object type

## Response `200`

Request successfully processed

- JsonApiUserGroupOutDocument
  - `data` JsonApiUserGroupOut, required: JSON:API representation of userGroup entity.
    - `attributes` object
      - `name` string
    - `id` string, required: API identifier of an object
    - `relationships` object
      - `parents` object
        - `data` JsonApiUserGroupLinkage[], required: References to other resource objects in a to-many (\"relationship\"). Relationships can be specified by including a member in a resource's links object.
          - `id` string, required
          - `type` 'userGroup', required
    - `type` 'userGroup', required: Object type
  - `included` JsonApiUserGroupOutWithLinks[]: Included resources
    - `attributes` object
      - `name` string
    - `id` string, required: API identifier of an object
    - `relationships` object
      - `parents` object
        - `data` JsonApiUserGroupLinkage[], required: References to other resource objects in a to-many (\"relationship\"). Relationships can be specified by including a member in a resource's links object.
          - `id` string, required
          - `type` 'userGroup', required
    - `type` 'userGroup', required: Object type
    - `links` ObjectLinks
      - `self` string, uri, required: A string containing the link's URL.
  - `links` ObjectLinks
    - `self` string, uri, required: A string containing the link's URL.
  - `meta` object
    - `restricted` RestrictedObject[]: References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.
      - `id` string, required: Object identifier, unique within one workspace hierarchy.
      - `type` 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'computedAttribute' | 'fact' | 'label' | 'metric' | 'userDataFilter' | 'visualizationObject', required: JSON:API type of the restricted object. Matches the `type` of its entry in the resource's `relationships`.

---

[API](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api.md) - [All operations](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/revisions/c728ef303bfb?raw)