LUlucid
Folders Sharing

Create Folder Share Link

Changed on

Creates a new share link on the provided folder with the provided settings. The linkSecurity parameter is only configurable for enterprise license users but is still required for team accounts. If an expiration is provided outside account-defined limits, it will be clamped to the maximum allowed time.

post/v1/folders/{id}/shares/shareLinks

Request

Path parameters

idnumber required

ID of the folder.

Request body

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.

Example request

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

Response

Created with a Folder Share Link resource containing information about the created 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"
}

Changes

  • 9c2c917ec59cRevision changes
    • breaking

      the response property / became nullable for the status

    • info

      the request property / became nullable