Update Share
Summary
Make changes to a share link.
Endpoint
PATCH https://mysite.files.com/api/v2/shares/{id}
Replace mysite.files.com with your site address.
Path Parameters
| Parameter | Description |
|---|---|
id | The internal ID number of the resource. |
Request Body Schema
| Name | Data Type | Notes |
|---|---|---|
name | string | Description of the share link. |
resources | array(string) | Files or folders included 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) |
accessMode | object | What operations can be performed by a web visitor to the share. See AccessMode Object for details. |
recipients | array(object) | List of people to be invited to the share. See Recipient Object for details. |
expiration | string | Share link expiration date. Must be in the future. |
hasNotification | boolean | Whether share link notifications should be sent. |
notificationEmails | array(strings) | 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 | New password for 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. |
status | integer | New status for a share. Revoke a share link by setting the status to 0. |
AccessMode Object
The accessMode object included in the request schema has the following properties.
| Name | Data Type |
|---|---|
download | boolean |
upload | boolean |
modify | boolean |
delete | boolean |
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.
| Name | Data Type |
|---|---|
email | 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