For the complete documentation index, see llms.txt. This page is also available as Markdown.

Sharing a folder

Use shareFolder to share a folder with users or groups. Each share can grant either view or edit permissions.

mutation ShareFolder(
  $folderId: String!
  $shares: [ShareFolderInput]
  $emailMessage: String
) {
  shareFolder(
    folder_id: $folderId
    shares: $shares
    email_message: $emailMessage
  ) {
    id
    name
    shares {
      id
      role
      is_by_link
      user {
        id
        name
        email
      }
      group {
        id
        name
      }
    }
  }
}

Variables to share wih a group or user:

To share with a group, provide the group_id instead of email.

The available values for role are:

Value
Permission

VIEWER

Allows the user or group to view the folder’s contents. This is the default value.

EDITOR

Allows the user or group to edit and manage the folder’s contents.

Updating a share

Use updateSharing to modify an already existing permission or configure link sharing.

Variables to change a permission:

Variables to activate sharing with link and password:

To remove the password, set removePassword to true . Do not provide password and removePassword at the same request, as they represent conflicting actions.

Last updated