Skip to content

archiveUserNotifications ​

Archives one or more Notifications for a given user i.e. set status to A=Archived. Used when a user just wants to make them disappear immediately from UI.

Notification Statuses Code | Name | Desc U | Unviewed | Not seen V | Viewed | Seen A | Archived | Moved to Archive table (out of scope for devices v1)

Request ​

http
PUT /rest/user/notifications/archive

Headers ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

Parameters ​

Sample Request:

json
{
       "userNotificationIds" : [1,2]
}

Response ​

200 OK ​

Standard OK wrapped in Error JSON

json
{
   "errorCode": 0,
   "errorMsg": "OK"
}

Errors ​

ExceptionDescription
WSInvalidAuthTokenExceptionSee Error Definitions
WSCacheServiceExceptionSee Error Definitions
WSInvalidParameterExceptionSee Error Definitions
WSUserNotificationServiceExceptionSee Error Definitions