Skip to main content
POST
/
v1
/
notification
/
inbox
/
mark_read
Set Read Status of Notifications
curl --request POST \
  --url https://api.orderly.org/v1/notification/inbox/mark_read \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>'
{
  "success": true,
  "timestamp": 1702989203989
}

Headers

​
orderly-timestamp
string
required
​
orderly-account-id
string
required
​
orderly-key
string
required
​
orderly-signature
string
required

Query Parameters

​
flag
number
required

The value of the read flag, where 1 = READ and 0 = UNREAD

​
ids
string[]
required

The list of notification ids to flag as read/unread.

Response

200 - application/json

OK

​
success
boolean
required
Example:

true

​
timestamp
integer
Example:

1702989203989