Replace a community's notification categories
PUT /api/communities/{communityId}/notification-categories. Replace a community's notification categories. Headless LMS Notifications API reference.
Requires communities:write. On the community. Stores the whole list for this community; other communities keep theirs. 422 when a key repeats, a type cannot be in a community list, a reason is not allowed for its type, a channel is not configured, perSpace is set on a type that cannot occur in a space, spaceDefaults appears without perSpace or names a channel the category does not offer, or earlier categories already cover everything a category covers.
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/api/communities/string/notification-categories" \ -H "Content-Type: application/json" \ -d '{ "categories": [ { "key": "string", "covers": [ { "type": "string", "reasons": [ "subject" ] } ], "channels": { "property1": { "default": true, "locked": true }, "property2": { "default": true, "locked": true } } } ] }'{ "categories": [ { "key": "string", "covers": [ { "type": "string", "reasons": [ "subject" ] } ], "channels": { "property1": { "default": true, "locked": true }, "property2": { "default": true, "locked": true } }, "perSpace": true, "spaceDefaults": { "property1": { "property1": true, "property2": true }, "property2": { "property1": true, "property2": true } } } ], "source": "default"}{ "error": "string", "message": "string", "requestId": "string", "issues": [ { "path": "string", "message": "string" } ]}{ "error": "string", "message": "string", "requestId": "string"}{ "error": "string", "message": "string", "requestId": "string"}{ "error": "string", "message": "string", "requestId": "string"}{ "error": "string", "message": "string", "requestId": "string", "issues": [ { "path": "string", "message": "string" } ]}{ "error": "string", "message": "string", "requestId": "string"}Go back to the default notification categories for a community DELETE
DELETE /api/communities/{communityId}/notification-categories. Go back to the default notification categories for a community. Headless LMS Notifications API reference.
List your notifications, newest first, with the unread count of the same filters GET
GET /api/member/notifications. List your notifications, newest first, with the unread count of the same filters. Headless LMS Notifications API reference.