Sign in
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"
    }
  ]
}

Changes

Changed in 4 of the 74 revisions of this API.7

  • ae20b30817de1See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • f1020c3ecda44See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • bdd0e2c70d581See the full diff
    • ○

      the security scope user:notifications:update was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 099fdc3be4221See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.