Skip to main content

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

ParameterDescription
idThe internal ID number of the resource.

Request Body Schema

NameData TypeNotes
namestringDescription of the share link.
resourcesarray(string)Files or folders included in the share link.
Specify each item as either the complete path (e.g. my/folder/file.txt) or as a resource ID (e.g. id:31415926535).
accessModeobjectOperations a web visitor to the share can perform. See AccessMode Object for details.
recipientsarray(object)People to invite to the share. See Recipient Object for details.
expirationstringShare link expiration date. Must be in the future.
hasNotificationbooleanWhether share link notifications are sent.
notificationEmailsarray(strings)List of email addresses that receive share link notifications.
Each email address must be associated with a user account within your site.
Ignored if hasNotification is false.
passwordstringNew password for the share link.
requireEmailbooleanWhether visitors to the share link must register before viewing the contents.
fileDropCreateFoldersbooleanWhether uploads to the share link are placed into an automatically created subfolder.
statusintegerNew 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.

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