addFolderShare(path, user, access, subject, message) Last updated: 22. May 2025

API only function

Creates a new share / overwrites existing for a specific folder and user, and sends a notification to the user.

Parameters

Name Type Description
path string Absolute path to folder to create a new share for
user string (email) Email for user.
access string A string with letters describing the access level:
B - browser (read in Docly and on websites)
C - Create new files and folders
M - modify (W also allowed) - requires R
V - Visit (web site read access only "Visit")

Example: "BM" meaning read and modify
subject string Email subject to send to user
message string Message to send to user

Returns

Always returns "null".

Example

Code example (JS)

JS is normal JavaScript either running in the browser or on the Docly™ server.
docly.addFolderShare("test file", "test@docly.net", "V", "Access granted to view file", "Here is the file");