---
title: "Update a usergroup"
method: PATCH
path: "/user-groups/{usergroup_id}"
tags: ["Usergroups"]
---

# Update a usergroup

`PATCH /user-groups/{usergroup_id}`

## Request

- Base URL: `https://api.kontainer.com/jsonapi/v2`
- URL: `https://api.kontainer.com/jsonapi/v2/user-groups/{usergroup_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/kontainer/apis/kontainer-api-documentation/docs/user-groups/:usergroup_id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Please note the exemplary request body. It updates all the fields; however, if one only seeks to update a specific field (e.g., name), please omit the others.

## Path parameters

- `usergroup_id` string, required

## Request body

- object
  - `data` object, required
    - `type` string, required: Resource Type. The plural spelling `user_groups` is deprecated and will be rejected in a future release; send `user_group`.
    - `attributes` object, required: Attributes
      - `name` string: Name
      - `note` string: Note to describe the intended users in the group
      - `active` boolean: active
      - `show_brand_section` boolean: show_brand_section
      - `hide_menu_by_default` boolean: hide_menu_by_default
      - `allow_folder_share` boolean: allow_folder_share
      - `allow_internal_folder_share` boolean: allow_internal_folder_share
      - `allow_cdn_activation_with_download_access` boolean: allow_cdn_activation_with_download_access

## Response `200`

updated

- UsergroupResponse
  - `data` Usergroup, required
    - `type` 'user_group', required
    - `id` string, required
    - `attributes` object, required
      - `name` string, required
      - `note` string, required
      - `active` boolean, required
      - `show_brand_section` 0 | 1, required: Stored flag returned uncast: `0` or `1` when the group is read back. Create and update responses echo the value that was submitted (a JSON boolean, `0`/`1` or `"0"`/`"1"`).
      - `hide_menu_by_default` boolean, required
      - `can_folder_share` boolean, required: Whether members may share folders externally. Written via `allow_folder_share`; always `false` while the client has external sharing disabled.
      - `can_internal_folder_share` boolean, required: Whether members may share folders internally. Written via `allow_internal_folder_share`.
      - `allow_cdn_activation_with_download_access` boolean, required
      - `is_sso_group` boolean, required: Whether the group is mapped to an SSO group name.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Unprocessable Entity

---

[API](https://skmtc.dev/kontainer/apis/kontainer-api-documentation.md) - [All operations](https://skmtc.dev/kontainer/apis/kontainer-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/kontainer/apis/kontainer-api-documentation/revisions/b80a5167e09a?raw)