Notifications

Mark Notifications Read

Changed on

Marks the authenticated user's notifications as read, for one experience or all of them, and returns the refreshed badge rows for that scope. Requires a user credential.

post/notifications/mark_read

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/notifications/mark_read
  • Auth: HTTP bearer

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

  • ae20b30817deRevision changes
    • info

      added the non-success response with the status

  • f1020c3ecda4Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status