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

Body

invitationsarray of unknown

notifyboolean

messagestring

culturestring

Examples

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

{
  "invitations": [
    {
      "int": 1234,
      "string": "some text",
      "boolean": true
    }
  ],
  "notify": true,
  "message": "some text",
  "culture": "some text"
}

curl --request PUT \
  --url https://example.com/api/2.0/files/rooms/2023/share \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "invitations": [
    {
      "int": 1234,
      "string": "some text",
      "boolean": true
    }
  ],
  "notify": true,
  "message": "some text",
  "culture": "some text"
}'

Responses

200

Room security information

membersarray of unknown

warningstring

401

Unauthorized

403

Forbidden