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}

Request

Base URL
https://api.lucid.co
Auth
- HTTP bearer
- or OAuth 2
  Authorization codehttps://lucid.app/oauth2/authorize
  Token URLhttps://api.lucid.co/oauth2/token
  Scopesfolder
TypeScript
https://skmtc.dev/lucid/apis/lucid-rest-api/docs/v1/folders/:id/shares/users/:userId/put.ts
A function with typed inputs. Its response is checked against the schema.

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

Changes

No recorded changes to this operation across all 2 revisions of this API.