addFolderShare(path, user, access, [message]) Last updated: 30. May 2026

API only function

Creates a new share / overwrites existing for a specific folder and user, and sends an invitation email to the specified user.

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
message (optional)	string	Optional message to send to user

Returns true for success or throws an error.

Example

JS is normal JavaScript either running in the browser or on the Docly™ server.

docly.addFolderShare("Test folder", "test@docly.net", "V", "Access granted to view folder");