Skip to main content
DELETE
/
v1
/
folders
/
{folderId}
/
permissions
Revoke folder permissions
curl --request DELETE \
  --url https://{instance}.omniapp.co/api/v1/folders/{folderId}/permissions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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
​
userIds
string<uuid>[]

The list of user IDs to revoke permissions from. 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 revoke permissions from. Use the List user groups endpoint to retrieve user group IDs.

Either userIds or userGroupIds is required.

Response

Permissions revoked successfully

​
success
boolean
Example:

true