OMomniapp
Folders

Update folder permission settings

Changed on

Set the role every member of the organization holds on a folder, without naming users or groups. organizationRole accepts NO_ACCESS, VIEWER, EDITOR, or MANAGER, or null to clear it. The role cascades to every descendant folder and document, so a single call can re-permission a whole tree.

put/api/v1/folders/{folderId}/permissions

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/folders/{folderId}/permissions
  • Auth
    HTTP bearer

Path parameters

folderIdstring uuid required

Unique identifier for the folder

Example:550e8400-e29b-41d4-a716-446655440000

Request body

organizationAccessBoostboolean

Whether everyone in the organization gets access boost on this folder. Setting it true requires an organization role that grants access, either sent in the same request or already on the folder; otherwise the request is rejected with 400. Rejected with 403 when the organization has AccessBoost turned off, or when a user-scoped key lacks boost provisioning.

Response

Permission settings updated successfully

successboolean required

Whether the permission settings were updated successfully

Changes