Set read status of notifications

Limit: 10 requests per 60 seconds

POST /v1/notification/inbox/mark_read

Set the read status on a list of notifications for a user.

POST /v1/notification/inbox/mark_read

Set read status of notifications

cURL

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>'

200

{
  "success": true,
  "timestamp": 1702989203989
}

Headers

orderly-timestamp · string · required

Timestamp of the signed request in milliseconds.

orderly-account-id · string · required

Account ID of the authenticated account.

orderly-key · string · required

Public orderly key used to sign the request.

orderly-signature · string · required

Signature of the request payload generated with the orderly key.

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

Indicates whether the request was successful.

Example:

true

timestamp · integer

Server timestamp in milliseconds.

Example:

1702989203989