Sign in

v1

latestOpenAPI 3.0.3Lucid2026-07-14155181312.3 KB
Folders Collaboration

Create/Update Folder User Collaborator

Updates or establishes a user's collaborator access to a given folder. If the user does not already have access, a new Folder User Collaborator Resource is created. Collaborators cannot be given the role "owner", and the role of the folder's owner cannot be modified.

put/v1/folders/{id}/shares/users/{userId}

Path parameters

idnumber required

ID of the folder.

userIdnumber required

ID of the user whose role to create or modify.

Request body

role'editandshare' | 'edit' | 'comment' | 'view'

The Collaborator Role to assign to the user for this folder.

Example request

{
  "role": "comment"
}

Response

OK when updating an existing Folder User Collaborator. Contains the updated Folder User Collaborator Resource.

folderIdinteger required

Folder ID

userIdinteger required

User ID

role'owner' | 'editandshare' | 'edit' | 'comment' | 'view' required

The Collaborator Role on the document or folder

createdstring date-time required

Date and time when the collaboration was created