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

Body

linkIdstringformat: uuid

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, RoomAdmin - Room admin, Editing - Editing, PowerUser - Power user]

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

.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 admin, 10 - Editing, 11 - Power user]

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

expirationDateobject

utcTimestringformat: date-time

timeZoneOffsetstringformat: date-span

titlestring

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

denyDownloadboolean

Examples

PUT /api/2.0/files/rooms/5016/links HTTP/1.1
Accept: application/json
Content-Length: 276
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": "refined_granite_chicken_administrator_nepal",
  "password": "jAhP23oUeu",
  "denyDownload": true
}

curl --request PUT \
  --url https://example.com/api/2.0/files/rooms/5016/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": "refined_granite_chicken_administrator_nepal",
  "password": "jAhP23oUeu",
  "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, RoomAdmin - Room admin, Editing - Editing, PowerUser - Power user]

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

.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 admin, 10 - Editing, 11 - Power user]

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

sharedTounknown

isLockedboolean

isOwnerboolean

canEditAccessboolean

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

403

Forbidden