Skip to main content
PATCH
/
v1
/
folders
/
{folderId}
/
permissions
Update folder permissions
curl --request PATCH \
  --url https://{instance}.omniapp.co/api/v1/folders/{folderId}/permissions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "NO_ACCESS",
  "accessBoost": false,
  "userIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "userGroupIds": [
    "<string>"
  ]
}
'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
folderId
string<uuid>
required

The UUID of the folder. Use the List folders endpoint to retrieve folder IDs.

Body

application/json
​
role
enum<string>
required

The content role to assign to the specified users or user groups.

Available options:
NO_ACCESS,
VIEWER,
EXPLORER,
EDITOR,
MANAGER
​
accessBoost
boolean
default:false

If true, AccessBoost is enabled for the folder.

​
userIds
string<uuid>[]

The list of user IDs to update permissions for. Use the List users or List embed users endpoints to retrieve user IDs.

Either userIds or userGroupIds is required.

​
userGroupIds
string[]

The list of user group IDs to update permissions for. Use the List user groups endpoint to retrieve user group IDs.

Either userIds or userGroupIds is required.

Response

Permissions updated successfully

​
success
boolean
Example:

true