Skip to content

Mark notifications read

Mark one notification or all notifications as read. Use an ID from notification view or pass all: true.

Parameters

#
notificationstring
A notification's ID (see notification view).
allboolean
Mark all notifications as read. Omit the notification ID.

Returns

#
dataobjectAlways present
Read and unread notification counts.
Show 2 attributesHide attributes
readintegerAlways present
Number marked read by this request.
unreadintegerAlways present
Number still unread afterward.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
payment_required402Payment or credit is required.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • API key permission: notification read.
  • One: Mark one notification as read. Required: notification.
  • All: Mark all your notifications as read. Required: all.