latestOpenAPI 3.0.02026-07-135965404.0 KB

a1bd874b5960

Update a share

Change the settings on an active share. Any changes made will affect all users that have access to the share.

When updating invitees, pass the recipients body paramater with the full list of people who should be included on the share. If you resend the list without an existing recipient, they will be removed from the share.

Setting the Share Permissions

Only 5 different combinations of permissions are valid for the accessMode object:

Upload Only: This allows share visitors to upload to a share but do nothing else to the contained files. To use this mode, set upload to true and all other permissions to false
Download Only: This allows share visitors to download files from a share but do nothing else to the contained files. To use this mode, set download to true and all other permissions to false
Upload and Download: This allows share visitors to upload new files to the share or download files within the share, but not make any other changes to the share contents. To use this mode, set upload and download to true and set both modify and delete to false
All but Delete: This allows share visitors to make any changes to the contents of a share except deleting files. To use this mode, set upload, download, and modify to true and set delete to false
Full Access: This allows share visitors to make any changes to the contents of a share. To use this mode, set all 4 permissions upload, download, modify, and delete to true

Any other combination of permissions provided as the accessMode will be rejected as a bad request.

Notes:

Authenticated user should be the owner of the specified share.

patch/shares/{id}

Headers

ev-api-keystring required

Example:exampleaccount-zwSuWUZ8S38h33qPS8v0s

API Key

ev-access-tokenstring required

Example:19853ef63a0bc348024a9e4cfd4a92520d2dfd04e88d8679fb1ed6bc551593d1

Access Token

Request body

namestring

Name of the share.

resourcesstring[]

Array of resources for this share. See details on how to specify resources above.

shared_folder and receive shares must have only one resource, which is a directory that does not have a current share attached.

send shares may have multiple resource parameters.

NOTE: Sending this parameter will REPLACE the existing resources with the resources included in this request.

embedboolean

Whether the share can be embedded in another web page.

expirationstring date-time

New expiration date and time for the share

hasNotificationboolean

Whether delivery receipts should be sent for this share.

isPublicboolean

Whether people can visit the share without following a link from an invitation email

messageBodystring

Message content to use for emails inviting recipients to the share. Ignored if you have not also provided recipients and a subject

notificationEmailsstring[]

List of email addresses to send delivery receipts to. Ignored if hasNotification is false.

passwordstring

New password for the share. To leave the password unchanged, do not send this parameter.

requireEmailboolean

Whether visitors to the share will be required to enter their email in order to access the share.

messageSubjectstring

Subject to use on emails inviting recipients to the share. Ignored if you have not also provided recipients and a message

fileDropCreateFoldersboolean

Whether uploads to a receive folder should be automatically placed into subfolders. See our receive folder documentation

statusinteger

New status for the share. You can set an active share to inactive by setting the status to 0

Example request

{
  "name": "Shared Folder",
  "resources": [
    "/testfolder"
  ],
  "expiration": "2017-09-25T14:12:10Z",
  "isPublic": true,
  "notificationEmails": [
    "notify@example.com",
    "notify2@example.com"
  ],
  "messageSubject": "Invitation to a shared folder"
}

Response

Successful operation

ShareResponse required— unresolved $ref