Mark Notification as Read API
Require Authentication
This API is used to mark notification as read for user based on combination of deviceID and token. When this API is invoked, system will recalculate badge number and resend the newest badge number to all devices.
URL
api/notifications/read
Required parameter (POST)
- deviceID
- token
- notificationrecipientsendingIDs «contain a list of notificationrecipientsendingID in array. At least there is 1 value that exist in database. To get a list of notificationrecipientsendingID for user, please refer to Get List of Notification Sent to Mobile»
Note: notificationrecipientsendingID is the same as messageID, but since it is a plural form (notificationrecipientsendingIDs), it can contain multiple notificationrecipientsendingID in array
Please give all notificationrecipientsendingID which is considered as "read" in a single API call so system will not recalculate badge number many times.
Optional parameter
Example JSON Payload
{
"deviceID": "ABCD-EFGH-IJKL-MNOP",
"token": "bb602ab13b8090268cd6e3bb9dfa39e2",
"notificationrecipientsendingIDs": [44,34]
}
Possible return HTTP status code
- 200
- 400
- 401
- 404
- 405
Return message
{
"status": "success",
"message": [
"Notification has been marked as read."
]
}