Get Started
Usage API
More information

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 string some text
share
sent in body
Collection of sharing parameters Collection of FileShareParamss
collection
share[0].ShareTo=9924256A-739C-462b-AF15-E652A3B1B6EB&share[0].Access=0
notify
sent in body
Notifies users about the shared file Bool value true
sharingMessage
sent in body
Message to send when notifying about the shared file string some text
Remark

Each of the "share" parameters must contain two values: 'ShareTo' - ID of the user with whom we want to share the file and 'Access' - access type which we want to grant to the user (Read, ReadWrite, etc).

Example
PUT api/2.0/files/file/some+text/share
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "share": [
    {
      "shareTo": "00000000-0000-0000-0000-000000000000",
      "access": 0
    }
  ],
  "notify": true,
  "sharingMessage": "some text"
}
Returns

Shared file information

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "access": 1,
      "sharedTo": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "isLocked": false,
      "isOwner": true
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <access>1</access>
    <sharedTo>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </sharedTo>
    <isLocked>false</isLocked>
    <isOwner>true</isOwner>
  </response>
</result>