Create a Share
Summary
Creates a new share link in your site.
Endpoint
POST https://mysite.files.com/v1.2/shares
Replace mysite.files.com with your site address.
Request Body Schema
| Name | Data Type | Notes |
|---|---|---|
access_token | string | Required. The session key that identifies which user is authenticated. Either an access token returned by the authenticateUser function, or a a Files.com user API Key. |
type | string | Required. Allowed values are shared_folder, receive and send. |
name | string | Required. A human readable description that will be publicly available to visitors. |
filePaths | array(string) | Required. One or more paths to include in the share link. Each item should be specified as the complete path (e.g. my/folder/file.txt or my/other/folder) |
accessMode | string | What operations can be performed by a web visitor to the share link. Valid options are: upload, download, download_upload, download_upload_modify_delete |
password | string | Password for visitors to the share link. |
expiration | date-time | When the share link will be unavailable to visitors. Must be in the future. |
emails | array(string) | List of email addresses to be invited to the share. |
message | string | Text to include in email invitations to recipients. |
isPublic | boolean | When 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. |
requireEmail | boolean | Whether visitors to the share link are required to register before viewing the contents. |
hasNotification | boolean | Whether share link notifications should be sent. |
notificationEmails | array(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. |
fileDropCreateFolders | boolean | Whether uploads to the share link should be placed into an automatically created subfolder. |