Set an external or invitation link

PUT /api/2.0/files/rooms/{id}/links

Request

Sets an external or invitation link with the ID specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Path

idintegerformat: int32required

Room ID

Body

Link parameters

linkIdstringformat: uuid

Link ID

accessone of

.enum of string

[None - None, ReadWrite - Read and write, Read - Read, Restrict - Restrict, Varies - Varies, Review - Review, Comment - Comment, FillForms - Fill forms, CustomFilter - Custom filter, RoomManager - Room manager, Editing - Editing, ContentCreator - Content creator]

Can be one of: None, ReadWrite, Read, Restrict, Varies, Review, Comment, FillForms, CustomFilter, RoomManager, Editing, ContentCreator.

.enum of integer

[0 - None, 1 - Read and write, 2 - Read, 3 - Restrict, 4 - Varies, 5 - Review, 6 - Comment, 7 - Fill forms, 8 - Custom filter, 9 - Room manager, 10 - Editing, 11 - Content creator]

Can be one of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11.

expirationDateobject

utcTimestringformat: date-time

UtcTime

timeZoneOffsetstringformat: date-span

TimeZoneOffset

titlestring

Link name

linkTypeone of

.enum of string

[Invitation - Invitation, External - External]

Can be one of: Invitation, External.

.enum of integer

[0 - Invitation, 1 - External]

Can be one of: 0, 1.

passwordstring

Link password

denyDownloadboolean

Specifies whether downloading a file from a link is disabled or not

Examples

PUT /api/2.0/files/rooms/3975/links HTTP/1.1
Accept: application/json
Content-Length: 266
Content-Type: application/json
Host: example.com

{
  "linkId": "75a5f745-f697-4418-b38d-0fe0d277e258",
  "expirationDate": {
    "utcTime": "2008-04-10T06:30:00.0000000+04:00",
    "timeZoneOffset": "00:00:00"
  },
  "title": "ergonomic_frozen_towels_ram_morph",
  "password": "h8Iz0WvT1j",
  "denyDownload": true
}

curl --request PUT \
  --url https://example.com/api/2.0/files/rooms/3975/links \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "linkId": "75a5f745-f697-4418-b38d-0fe0d277e258",
  "expirationDate": {
    "utcTime": "2008-04-10T06:30:00.0000000+04:00",
    "timeZoneOffset": "00:00:00"
  },
  "title": "ergonomic_frozen_towels_ram_morph",
  "password": "h8Iz0WvT1j",
  "denyDownload": true
}'

Responses

200

Room security information

accessone of

.enum of string

[None - None, ReadWrite - Read and write, Read - Read, Restrict - Restrict, Varies - Varies, Review - Review, Comment - Comment, FillForms - Fill forms, CustomFilter - Custom filter, RoomManager - Room manager, Editing - Editing, ContentCreator - Content creator]

Can be one of: None, ReadWrite, Read, Restrict, Varies, Review, Comment, FillForms, CustomFilter, RoomManager, Editing, ContentCreator.

.enum of integer

[0 - None, 1 - Read and write, 2 - Read, 3 - Restrict, 4 - Varies, 5 - Review, 6 - Comment, 7 - Fill forms, 8 - Custom filter, 9 - Room manager, 10 - Editing, 11 - Content creator]

Can be one of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11.

sharedTounknown

A user who has the access to the specified file

isLockedboolean

Specifies if the file is locked by this user or not

isOwnerboolean

Specifies if this user is an owner of the specified file or not

canEditAccessboolean

Spceifies if this user can edit the access to the specified file or not

subjectTypeone of

.enum of string

[User - User, ExternalLink - External link, Group - Group, InvitationLink - Invitation link, PrimaryExternalLink - Primary external link]

Can be one of: User, ExternalLink, Group, InvitationLink, PrimaryExternalLink.

.enum of integer

[0 - User, 1 - External link, 2 - Group, 3 - Invitation link, 4 - Primary external link]

Can be one of: 0, 1, 2, 3, 4.

401

Unauthorized