Set room access rights

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

Request

Sets the access rights to a room 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

Request parameters for inviting users to a room

invitationsarray of object

Collection of invitation parameters

emailstringformat: email

Email address

idstringformat: uuid

ID of the user with whom we want to share a room

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.

notifyboolean

Notifies users about the shared room or not

messagestring

Message to send when notifying about the shared room

culturestring

Culture

Examples

PUT /api/2.0/files/rooms/2330/share HTTP/1.1
Accept: application/json
Content-Length: 234
Content-Type: application/json
Host: example.com

{
  "invitations": [
    {
      "value": {
        "email": "Nathanael.Mayer55@gmail.com",
        "id": "6941feb5-054e-4164-9706-a2acfb484098"
      }
    }
  ],
  "notify": true,
  "message": "some text",
  "culture": "some text"
}

curl --request PUT \
  --url https://example.com/api/2.0/files/rooms/2330/share \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "invitations": [
    {
      "value": {
        "email": "Nathanael.Mayer55@gmail.com",
        "id": "6941feb5-054e-4164-9706-a2acfb484098"
      }
    }
  ],
  "notify": true,
  "message": "some text",
  "culture": "some text"
}'

Responses

200

Room security information

membersarray of object

List of room members

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.

warningstring

Warning

401

Unauthorized