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

Description

Sets an external or invitation link 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 guid 9924256A-739C-462b-AF15-E652A3B1B6EB
Title
sent in body
Link name string some text
Access
sent in body
Sharing rights None, ReadWrite, Read, Restrict, Varies, Review, Comment, FillForms, CustomFilter, RoomAdmin, Editing, Collaborator ReadWrite
ExpirationDate
sent in body
Link expiration date Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
LinkType
sent in body
Link type ASC.Files.Core.ApiModels.ResponseDto.LinkType
Password
sent in body
Link password string some text
DenyDownload
sent in body
Specifies whether downloading a file from a link is disabled or not Bool value true
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",
  "ExpirationDate": "2008-04-10T06-30-00.000Z",
  "Password": "some text",
  "DenyDownload": true
}
Returns

Room security information

Example Response
{
  "status": 0,
  "response": {
    "Access": "ReadWrite",
    "IsLocked": true,
    "IsOwner": true,
    "CanEditAccess": true
  }
}