Skip to main content
POST
Grant folder permissions

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. Must be one of:

  • NO_ACCESS - No access
  • VIEWER - View folder contents
  • EDITOR - Edit and add content to the folder
  • MANAGER - Edit, add content, and manage folder permissions
  • OWNER - Manager permissions and receives access requests. The document must have at least one owner at all times.
Available options:
NO_ACCESS,
VIEWER,
EDITOR,
MANAGER,
OWNER
Example:

"EDITOR"

accessBoost
boolean
default:false

If true, AccessBoost is enabled for the folder. Setting this to false is always allowed. Setting this to true with a user-scoped API key requires that the organization's Non-administrators can enable AccessBoost on content setting is enabled and that the user has permission to enable AccessBoost, or the request returns a 403 error. Organization-scoped API keys are not subject to this check.

Example:

false

userIds
string<uuid>[]

The list of user IDs to assign permissions to. Use the List users and List embed users endpoints to retrieve user IDs. Either userIds or userGroupIds is required.

Example:
userGroupIds
string[]

The list of user group IDs to assign permissions to. Use the List user groups endpoint to retrieve user group IDs. Either userIds or userGroupIds is required.

Example:

Response

Permissions granted successfully

success
boolean
Example:

true