Skip to content

Mark everything read for a user

PATCH
/v1/notifications/read-all

Marks this user’s direct notifications, groups and the broadcasts of the last 30 days read; send category to mark one tab only. With a secret key and no user_id, marks every direct notification in the project read. A browser call always needs the hash.

Auth: Publishable key from the browser, with user_id and user_hash = HMAC-SHA256(signing secret, user_id) as lowercase hex, in the X-Nordva-User-Hash header or a user_hash parameter. A secret key may name any user_id and needs no hash. A wrong or missing hash answers USER_HASH_INVALID (403).

Rate limits: a browser call counts against 120 requests a minute per IP address (not the key’s budget), and the bell reads (/inbox, /unread, /unread/count) share a per-user hourly budget: Free 180, Indie 540, Builder 720 (RATE_LIMITED, 429, with Retry-After).

CORS: Access-Control-Allow-Origin: *.

X-Nordva-User-Hash
string

HMAC-SHA256(signing secret, user_id), lowercase hex.

user_hash
string

The same hash, when a header is inconvenient.

object
user_id
string
<= 256 characters
user_hash

Instead of the header.

string

How many changed

object
data
object
marked_read
integer
error
null
meta
object

Error envelope. See error.code for the discriminator.

object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties

Error envelope. See error.code for the discriminator.

object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties

Error envelope. See error.code for the discriminator.

object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties