Clears the requesting user's inbox up to a point in time. Every notification raised at or before it is marked seen and left out of listNotifications, getUnreadCount and getUnseen from then on.
Input
Encoding
application/jsonclearedAt
stringdatetime
Required
Notifications raised at or before this time are cleared. A time in the future is treated as now, and a time before an earlier clear leaves that clear in place.
Output
Encoding
application/jsonclearedAt
stringdatetime
Required
The point the inbox is now cleared up to.
unread
integer
Required
Number of unread notifications remaining.
Errors
AuthRequired
The request has no valid service auth. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"description": "Clears the requesting user's inbox up to a point in time. Every notification raised at or before it is marked seen and left out of listNotifications, getUnreadCount and getUnseen from then on.",
"errors": [
{
"description": "The request has no valid service auth.",
"name": "AuthRequired"
}
],
"input": {
"encoding": "application/json",
"schema": {
"properties": {
"clearedAt": {
"description": "Notifications raised at or before this time are cleared. A time in the future is treated as now, and a time before an earlier clear leaves that clear in place.",
"format": "datetime",
"type": "string"
}
},
"required": [
"clearedAt"
],
"type": "object"
}
},
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"clearedAt": {
"description": "The point the inbox is now cleared up to.",
"format": "datetime",
"type": "string"
},
"unread": {
"description": "Number of unread notifications remaining.",
"type": "integer"
}
},
"required": [
"clearedAt",
"unread"
],
"type": "object"
}
},
"type": "procedure"
}