Mark all notifications as read
POST {{baseUrl}}/notifications/read?archived=<boolean>&read=<boolean>&seen=<boolean>&categories=<string>&categories=<string>&topics=<string>&topics=<string>
Mark all notifications of a user as read. When you call this endpoint, the notification inboxes of this user will be updated in real-time.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
archived | string | A filter on the notifications based on the archived state. Specify false to select unarchived notifications. Defaults to null. | |
read | string | A filter on the notifications based on the read state. Specify false to select unread notifications. Defaults to null. | |
seen | string | A filter on the notifications based on the seen state. Specify false to select unseen notifications. Defaults to null. | |
categories | string | A filter on the notifications based on the category. If you want to get uncategorized notifications, use the "uncategorized" value. | |
The value can be either an array of strings or a comma-separated string. | |||
categories | string | A filter on the notifications based on the category. If you want to get uncategorized notifications, use the "uncategorized" value. | |
The value can be either an array of strings or a comma-separated string. | |||
topics | string | A filter on the notifications based on the topic. | |
topics | string | A filter on the notifications based on the topic. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-MAGICBELL-API-KEY | string | (Required) The (public) API key of your MagicBell project. | |
X-MAGICBELL-USER-EXTERNAL-ID | string | ID of the user. Provide the X-MAGICBELL-USER-EMAIL header instead if you identify users by email. | |
X-MAGICBELL-USER-EMAIL | string | Email address of the user. Provide the X-MAGICBELL-USER-EXTERNAL-ID header instead if you identify users by ID. | |
X-MAGICBELL-USER-HMAC | string | HMAC calculated with the API secret and ID, or email, of the user. Required if the project has HMAC enabled. |