Check notification availability

GET /api/2.0/settings/notification/{type}

Request

Checks if the notification type specified in the request is enabled or not.

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.

Path

typeone ofrequired

Notification type (Badges, RoomsActivity, DailyFeed, UsefullTips)

.enum of string

[Badges - Badges, RoomsActivity - Rooms activity, DailyFeed - Daily feed, UsefullTips - Usefull tips]

Can be one of: Badges, RoomsActivity, DailyFeed, UsefullTips.

.enum of integer

[0 - Badges, 1 - Rooms activity, 2 - Daily feed, 3 - Usefull tips]

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

Examples

GET /api/2.0/settings/notification/%7Btype%7D HTTP/1.1
Accept: application/json
Host: example.com
curl --request GET \
  --url https://example.com/api/2.0/settings/notification/%7Btype%7D \
  --header 'Accept: application/json'

Responses

200

Notification settings

typeone of
.enum of string

[Badges - Badges, RoomsActivity - Rooms activity, DailyFeed - Daily feed, UsefullTips - Usefull tips]

Can be one of: Badges, RoomsActivity, DailyFeed, UsefullTips.

.enum of integer

[0 - Badges, 1 - Rooms activity, 2 - Daily feed, 3 - Usefull tips]

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

isEnabledboolean

Specifies if the notification type is enabled or not

401

Unauthorized

403

Forbidden

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).