---
title: "Update folder usergroup permission"
method: PATCH
path: "/dam/folders/{folder_id}/user-groups/{user_group_id}/permissions"
tags: ["DAM: Folders: Usergroup Permissions"]
---

# Update folder usergroup permission

`PATCH /dam/folders/{folder_id}/user-groups/{user_group_id}/permissions`

## Request

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

## Path parameters

- `folder_id` string, required
- `user_group_id` string, required

## Request body

- object
  - `data` object, required
    - `type` string
    - `attributes` object
      - `given_permission` 'none' | 'inherit' | 'read' | 'download' | 'write'
      - `release_at` string, date-time, nullable: Schedule the change for this RFC 3339 instant instead of applying it now. The UTC offset is required. Must be in the future and before 9999-01-01T00:00:00Z, and scheduled permissions must be enabled for the client.

## Response `200`

updated

- FolderUsergroupPermissionDocument
  - `data` FolderUsergroupPermission, required
    - `type` string
    - `id` string
    - `attributes` FolderUsergroupPermissionAttributes
      - `given_permission` string, nullable
      - `inherited_user_group_permission` string, nullable
    - `meta` FolderUsergroupPermissionMeta
      - `folder_id` integer, required
      - `user_group_id` integer, required
      - `scheduled_permissions` ScheduledFolderPermission[], required: Pending scheduled changes for this folder, earliest first
        - `release_date_id` integer, required
        - `given_permission` 'none' | 'inherit' | 'read' | 'download' | 'write', required
        - `release_at` string, date-time, required: Always UTC

## Other responses

- `202`: scheduled; the current permission is returned unchanged and the change is applied at release_at
- `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)