Get Started
API backend
API system
More information

PUT api/2.0/files/share This function requires authentication

Description

Sets the sharing rights to all the files and folders specified in the request.

Parameters
Name Description Type Example
Share
sent in body
Collection of sharing parameters System.Collections.Generic.IAsyncEnumIEnumerableerable{ASC.Files.Core.ApiModels.FileShareParams}
Notify
sent in body
Notifies users about the shared file or not System.Boolean
SharingMessage
sent in body
Message to send when notifying about the shared file System.String
Example
PUT api/2.0/files/share
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "Notify": true,
  "SharingMessage": "some text"
}
Returns

List of shared files and folders information: sharing rights, a user who has the access to the specified folder, the folder is locked by this user or not, this user is an owner of the specified folder or not, this user can edit the access to the specified folder or not

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "Access": "ReadWrite",
      "IsLocked": true,
      "IsOwner": true,
      "CanEditAccess": true
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <Access>ReadWrite</Access>
    <IsLocked>True</IsLocked>
    <IsOwner>True</IsOwner>
    <CanEditAccess>True</CanEditAccess>
  </response>
</result>