Create document permission

Creates a new permission assignment for a user or group within the document, granting them specific roles and access levels. Can also be used to request access to the document when the user doesn’t have editor or workspace manager permissions.

Authorization: Requires document editor or workspace manager permissions, unless requestPermission is true. Parameters: Use requestPermission to indicate the user is requesting access to the resource. Roles: Supports editor and viewer roles.

Path Parameters

organizationName · string · required

workspaceName · string · required

documentPath · string · required

Query Parameters

requestPermission · boolean · default: false

Body

application/json

userGroupId · string

permission · enum<string>

Available options:

editor,

viewer

inheritedPermission · enum<string>

Available options:

manager,

viewer

message · string

createdAt · string<date-time>

updatedAt · string<date-time>

Response

200

application/json

userGroupId · string

permission · enum<string>

Available options:

editor,

viewer

inheritedPermission · enum<string>

Available options:

manager,

viewer

message · string

createdAt · string<date-time>

updatedAt · string<date-time>