Create a Share
Creates a new share link in your site.
POST https://mysite.files.com/api/v2/shares
Replace mysite.files.com with your site address.
| Name | Data Type | Notes |
|---|---|---|
| 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. |
| resources | array(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. |
| accessMode | object | What operations can be performed by a web visitor to the share link. See AccessMode Object for details. |
| recipients | array(object) | List of people to be invited to the share. See Recipient Object for details. |
| expiration | date-time | When the share link will be unavailable to visitors. Must be in the future. |
| hasNotification | boolean | Whether share link notifications should be sent. |
| 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. |
| messageBody | string | Text to include in email invitations to recipients. |
| 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. |
| password | string | Password for visitors to the share link. |
| requireEmail | boolean | Whether visitors to the share link are required to register before viewing the contents. |
| fileDropCreateFolders | boolean | Whether uploads to the share link should be placed into an automatically created subfolder. |
The accessMode object included in the request schema has the following properties.
| Name | Data Type |
|---|---|
| download | boolean |
| upload | boolean |
| modify | boolean |
| delete | boolean |
The recipient object included in the request schema has the following properties. You must provide a valid email address for the email property.
| Name | Data Type |
|---|---|
| string |
Get Instant Access to Files.com
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