latestOpenAPI 3.1.02026-08-19211327769.4 KB

e77ab32034c9

Documents

Add document permits

post/api/v1/documents/{identifier}/permissions

Path parameters

identifierstring required

Document identifier (either document ID or identifier slug)

Example:abc123

Document identifier (either document ID or identifier slug)

Request body

accessBoostboolean

Grant access boost. Rejected with 403 when the organization has AccessBoost turned off.

role'NO_ACCESS' | 'VIEWER' | 'EXPLORER' | 'EDITOR' | 'MANAGER' | 'OWNER' required

Role to grant

userGroupIdsstring[]

User group IDs to grant access to

userIdsstring[]

User membership IDs to grant access to

Response

Permissions added successfully

successboolean required

Whether the operation was successful

Example response

{
  "success": true
}