Get Read State

GET 
/api/cloud/2.0/agg/notifications/list/state/:notification-id

Overview

Get readState of the notification whose id specified in the API path parameter.

This is a per-user query.

Request

Path Parameters

notification-profile-id stringrequired

Responses

200

OK

application/json

Schema

Schema

notifIds string[]

List of notification IDs

readState NotifReadState (string)

Possible values: [READ, UNREAD]

Read state of the notification

Example (from schema)

{
  "notifIds": [
    "string"
  ],
  "readState": "READ"
}

Example

{
  "data": {
    "aggKey": {
      "category": "UPGRADES_category1",
      "notifType": "UPGRADES",
      "subCategory": "UPGRADES_category1_sub_category",
      "tsgId": "1091039496",
      "inAppFlag": true
    },
    "body": "body",
    "id": "1",
    "impactedTenantCount": 2,
    "impactedTenants": [
      "1091039497",
      "1091039496"
    ],
    "name": "abc",
    "channels": [],
    "createdTime": 1,
    "readState": "READ"
  },
  "requestId": "d99c59a0-f271-41b4-b9af-8d7c72829aa6"
}

Loading...