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.

POST/organizations/{organizationName}/workspaces/{workspaceName}/documents/{documentPath}/permissions

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

organizationName*string

The unique identifier of the organization

Match^[a-zA-Z0-9_ -]+$

workspaceName*string

The unique identifier of the workspace

Match^(?!.*\*)(?!.*[/]).{1,63}$

documentPath*string

The path to the document within the workspace

Match^(?!.*\.\.)[a-zA-Z0-9_/. \-&:,'+?!()$^–—]+$

Lengthlength <= 255

Query Parameters

requestPermission?boolean

Indicates that the user is requesting access to the resource

Defaultfalse

Request Body

application/json

Represents a permission assignment for a user or group within a document

userGroupId?UserGroupId

A resource identifier that uniquely identifies either a user or a group within the system. This identifier is used throughout the API for permission management and access control.

Format:

For users: user:{email} or user:{userId}
For groups: group:{groupName}

Match^(user:[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}|group:[a-zA-Z0-9._-]+)$

permission?string

The role/permission level granted to the user or group

Value in

"editor"
"viewer"

inheritedPermission?string

The permission level inherited from parent workspace

Value in

"manager"
"viewer"

message?string

Optional message or note about the permission assignment

createdAt?string

ISO 8601 timestamp indicating when the permission was created

Formatdate-time

updatedAt?string

ISO 8601 timestamp indicating when the permission was last modified

Formatdate-time

Response Body

`application/json`

curl --request POST \  --url 'https://example.com/organizations/string/workspaces/string/documents/string/permissions' \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{}'

{  "userGroupId": "string",  "permission": "editor",  "inheritedPermission": "manager",  "message": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Create document permission

Authorization

Path Parameters

Query Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`