PUT api/2.0/files/rooms/{id}/links This function requires authentication

Description

Sets an external link to invite the users to a room with the ID specified in the request.

Parameters
Name Description Type Example
id
sent in url
Room ID number 1234
LinkId
sent in body
Link ID System.Guid
Title
sent in body
External link name System.String
Access
sent in body
Sharing rights ASC.Files.Core.Security.FileShare
Example
PUT api/2.0/files/rooms/1234/links
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "LinkId": "9924256A-739C-462b-AF15-E652A3B1B6EB",
  "Title": "some text",
  "Access": "ReadWrite"
}
Returns

Security information of room files

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>