headless lms

Read how you are told about each notification category in a community

GET /api/member/communities/{communityId}/settings/notifications. Read how you are told about each notification category in a community. Headless LMS Notifications API reference.

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

For anyone who can open the community. One entry per category of the list in use that can apply to you, each with the channels it offers on this deployment, whether each is on for you and why (locked, space, community, spaceDefault or default), and default, what the channel would be without your own setting at that level. A per-space category also lists every space you can open, with its name. digest is the digest schedule of the community, null when it sends none. 404 when you cannot open the community.

Path Parameters

communityId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/member/communities/string/settings/notifications"
{  "communityId": "string",  "digest": {    "cadence": "daily",    "weekday": 0,    "hour": 0,    "timeZone": "string"  },  "categories": [    {      "key": "string",      "perSpace": true,      "channels": [        {          "channel": "string",          "enabled": true,          "default": true,          "source": "locked",          "locked": true        }      ],      "spaces": [        {          "spaceId": "string",          "name": "string",          "channels": [            {              "channel": "string",              "enabled": true,              "default": true,              "source": "locked",              "locked": true            }          ]        }      ]    }  ]}
{  "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"}