PUT api/2.0/files/file/{fileId}/share This function requires authentication

Description

Sets the sharing settings to a file with the ID specified in the request.

Parameters

Name	Description	Type	Example
fileId sent in url	File ID	`0
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/file/{fileid}/share
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

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

Returns

List of shared file information: sharing rights, a user who has the access to the specified file, the file is locked by this user or not, this user is an owner of the specified file or not, this user can edit the access to the specified file 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>