headless lms

Switch notification categories on or off per channel in a community

PATCH /api/member/communities/{communityId}/settings/notifications. Switch notification categories on or off per channel in a community. Headless LMS Notifications API reference.

PATCH
/api/member/communities/{communityId}/settings/notifications

For anyone who can open the community. Each setting switches one category on one channel, for all spaces or, for a per-space category, for one space; enabled: null removes your choice so the default applies again. Settings left out keep their values. 404 when you cannot open the community; 422 when a category does not exist, does not offer the channel, the channel is locked, or spaceId is given for a category that is not per space.

Path Parameters

communityId*string

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 PATCH "https://example.com/api/member/communities/string/settings/notifications" \  -H "Content-Type: application/json" \  -d '{    "settings": [      {        "category": "string",        "channel": "string",        "enabled": true      }    ]  }'
null
{  "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"}