Mark Notifications as Read
This API marks one or more specific notifications as read, identified by their IDs.
Endpoint Details
| URL | /v1/notifications/mark-read |
| Method | POST |
| Authorization | Bearer Token |
Request Headers
| Header | Type | Description |
|---|---|---|
| Content-Type | String | Must be application/json |
Request Body
Use the following format to make a request:
JSON Request
{
"ids": [
"363bc3b6-74eb-40df-8c1c-04ec61e1dc7a"
]
}
Parameters
| Parameter | Type | Description |
|---|---|---|
| ids | Array | List of notification IDs to mark as read |
Response
Here is an example response after the request has been successfully processed:
Response
{
"success": true
}
Field Descriptions
| Field | Type | Description |
|---|---|---|
| success | Boolean | Indicates whether the notifications were successfully marked as read |
info
- A valid Bearer Token is required to access this endpoint.
- Each ID in the
idsarray must reference an existing notification. - Only the notifications specified in the request are marked as read.