Set room notification status

POST /api/2.0/settings/notification/rooms

Request

Sets a notification status for 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.

Body

Request parameters for the room notification settings

roomsIdunknown

Room ID

muteboolean

Specifies if the room notifications are disabled or not

Examples

POST /api/2.0/settings/notification/rooms HTTP/1.1
Accept: application/json
Content-Length: 102
Content-Type: application/json
Host: example.com

{
  "roomsId": {
    "int": 1234,
    "string": "some text",
    "boolean": true
  },
  "mute": true
}
curl --request POST \
  --url https://example.com/api/2.0/settings/notification/rooms \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "roomsId": {
    "int": 1234,
    "string": "some text",
    "boolean": true
  },
  "mute": true
}'

Responses

200

Room notification settings

disabledRoomsarray of object

List of rooms with the disabled notifications

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).