Create a Share


Creates a new share link in your site.



Replace with your site address.

Request Body Schema

NameData TypeNotes
typestring Required. Allowed values are "shared_folder", "receive" and "send".
namestring Required. A human readable description that will be publicly available to visitors.
resourcesarray(string)Required. One or more paths to include in the share link.
Each item should be specified as either the complete path (e.g. "My/folder/file.txt") or as a resource ID (e.g. "id:31415926535")
When the type of share is "shared_folder" or "receive", you can use only 1 path, which must be a folder.
accessModeobjectWhat operations can be performed by a web visitor to the share link.
See AccessMode Object for details.
recipientsarray(object)List of people to be invited to the share. See Recipient Object for details.
expirationdate-timeWhen the share link will be unavailable to visitors. Must be in the future.
hasNotificationbooleanWhether share link notifications should be sent.
isPublicbooleanWhen true, the share link will be accessible to any web visitor at its address.
When false, the share link will only be available to recipients who have been emailed a personalized link.
messageBodystringText to include in email invitations to recipients.
notificationEmailsarray(string)List of email addresses to receive share link notifications.
Each email address must be associated with a user account within your site.
Ignored if hasNotification is false.
passwordstringPassword for visitors to the share link.
requireEmailbooleanWhether visitors to the share link are required to register before viewing the contents.
fileDropCreateFoldersbooleanWhether uploads to the share link should be placed into an automatically created subfolder.

AccessMode Object

The accessMode object included in the request schema has the following properties.

NameData Type

Recipient Object

The recipient object included in the request schema has the following properties. You must provide a valid email address for the email property.

NameData Type

Get Instant Access to

The button below will take you to our Free Trial signup page. Click on the white "Start My Free Trial" button, then fill out the short form on the next page. Your account will be activated instantly. You can dive in and start yourself or let us help. The choice is yours.

Start My Free Trial

©2024 All right reserved


  • Start My Free Trial
  • Pricing
  • Docs
  • API and SDKs
  • Contact


(800) 286-8372


9am–8pm Eastern