Skip to main content

Create a Share

Summary

Creates a new share link in your site.

Endpoint

POST https://mysite.files.com/api/v2/shares

Replace mysite.files.com with your site address.

Request Body Schema

NameData TypeNotes
typestring Required. Allowed values are shared_folder, receive and send.
namestringRequired. 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
downloadboolean
uploadboolean
modifyboolean
deleteboolean

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
emailstring

Ready to Transform Your File Infrastructure?

Join over 4,000 organizations that trust Files.com to manage their mission-critical file flows. Start your free trial today and see why we're the #1 rated file orchestration platform.

No credit card required • 7-day free trial • Setup in minutes