curl --request POST \
  --url https://api.rampartcorporation.com/developer/v1/notifications/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-token: <x-account-token>' \
  --data '{
  "notificationIds": [
    "notification-123",
    "notification-456"
  ]
}'
{
  "success": true,
  "message": "2 notifications marked as read",
  "count": 2
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <API_KEY>.

Headers

​
x-account-token
string
required

Account token for authentication

Body

application/json
​
notificationIds
string[]

Optional array of notification IDs to mark as read. If omitted, all notifications will be marked as read.

Example:
["notification-123", "notification-456"]

Response

200 - application/json
Successfully marked notifications as read
​
success
boolean
required

Indicates if the operation was successful

Example:

true

​
message
string
required

Human-readable message about the operation result

Example:

"2 notifications marked as read"

​
count
number
required

Number of notifications that were marked as read

Example:

2