Sign in

v1

latestOpenAPI 3.0.3Lucid2026-07-14155181312.3 KB
Folders Sharing

Update Folder Share Link

Updates an existing share link to the provided settings. If any settings are omitted, the existing settings are preserved. Share links are only updatable by the OAuth2.0 client that created them. If an expiration is provided outside the account-defined limits, it will be clamped to the maximum allowed time.

patch/v1/folders/{id}/shares/shareLinks/{shareLinkId}

Path parameters

idnumber required

ID of the folder.

shareLinkIdstring required

ID of the share link belonging to the folder.

Request body

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

Roles determine what actions an invitation will grant on a document. Invitations to a document only grant the specified level of access to just that one document. If a link's role is changed, the new role applies immediately to all users who accessed via that link.

  • editandshare: View, comment on, edit, and control which users can access the document.
  • edit: View, comment on, and edit the document.
  • comment: View the document. Leave comments on the document.
  • view: View the document.

Example request

{
  "linkSecurity": {
    "restrictToAccount": true,
    "expires": "2025-11-11T21:48:35.293Z",
    "passcode": "passcode"
  }
}

Response

OK with a Folder Share Link resource containing information about the updated share link.

shareLinkIdstring required

Id of the share link.

folderIdnumber required

Id of the folder the share link belongs to.

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

Roles determine what actions an invitation will grant on a document. Invitations to a document only grant the specified level of access to just that one document. If a link's role is changed, the new role applies immediately to all users who accessed via that link.

  • editandshare: View, comment on, edit, and control which users can access the document.
  • edit: View, comment on, and edit the document.
  • comment: View the document. Leave comments on the document.
  • view: View the document.
createdstring date-time required

The date and time the share link was created.

createdBynumber required

User Id of the user that created the share link.

lastModifiedstring date-time required

The date and time the share link was last modified.

acceptUrlstring uri required

Link to accept the share link invitation.

Example response

{
  "shareLinkId": "inv_8a38797a-e5fc-4479-8492-e000dc93cb60",
  "folderId": 123456,
  "linkSecurity": {
    "restrictToAccount": true,
    "expires": "2025-11-11T21:48:35.293Z",
    "passcode": "passcode"
  },
  "created": "2022-11-11T21:48:35.293Z",
  "createdBy": 1280,
  "lastModified": "2022-11-11T21:48:35.293Z",
  "acceptUrl": "https://lucid.app/folder/invitations/accept/inv_8a38797a-e5fc-4479-8492-e000dc93cb60"
}