Update a list of notifications based on the notification ids and action passed in Only notifications for the current user can be updated
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type, including the request body. |
Request Body
NotificationUpdateRequest
| Property | Description | Type |
|---|---|---|
| action | Action to perform Unread marks all notifications in the list as unread Read marks all notifications in the list as read Archived marks all notifications in the list as archived Unarchived marks all notifications in the list as unarchived One of ‘Read’, ‘Unread’, ‘Archived’, ‘Unarchived’ Required | string |
| notificationIds | List of notification ids to perform the action on Cannot be Empty Required (defined) | integer[] |
Example Request Body
{ "action": "string", "notificationIds": [
1
]
}
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
UpdateResult
| Property | Description | Type |
|---|---|---|
| selected | Required (defined) | integer (int32) |
| updated | Required (defined) | integer (int32) |
Example Response
{ "selected": 1, "updated": 1
}