Sign in
OpenAPI 3.1.02026-08-143874115.7 MB

a84d4905fdbb

Notifications

Mark Notifications Read

Marks the authenticated user's notifications as read: one experience's (experience_id) or everything (all: true) — exactly one of the two. Requires a user credential. Responds with the refreshed badge rows for the affected scope.

post/notifications/mark_read

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

allboolean

Pass true to mark every notification read. Exactly one of experience_id or all is required.

experience_idstring

Experience to mark read (exp_ tag). Exactly one of experience_id or all is required.

Example request

{
  "all": true,
  "experience_id": "exp_xxxxxxxxxxxxxx"
}

Response

notifications marked read

Example response

{
  "data": [
    {
      "account_id": "biz_xxxxxxxxxxxxxx",
      "experience_id": "exp_xxxxxxxxxxxxxx",
      "last_viewed_at": "2026-01-01T12:00:00.000Z"
    }
  ]
}