Folders Collaboration

Create/Update Folder Group Collaborator

Grants a group direct collaborator access to a given folder, or updates the group's role on the folder if it is already a collaborator.

put/v1/folders/{id}/shares/groups/{groupId}

Request

  • Base URL: https://api.lucid.co
  • URL: https://api.lucid.co/v1/folders/{id}/shares/groups/{groupId}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://lucid.app/oauth2/authorize, token URL https://api.lucid.co/oauth2/token, scopes: folder)

Path parameters

idnumber required

Folder ID.

groupIdnumber required

Group ID.

Request body

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

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

Example request

{
  "role": "comment"
}

Response

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

folderIdinteger required

Folder ID

groupIdinteger required

Group 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 1 revision of this API.