Notifications

Mark all notifications as read

POST/notifications/actions/mark-all-read
notifications:writemark_all_read_notifications

Marks every notification of the acting user read and returns how many it marked in affected, counting ones already read, whose read_at is stamped again. Calling again returns the same count. The pending "new notifications" email digest lists only unread notifications, so this suppresses it. The user's other open sessions are not told to refresh. It takes no body. dry_run counts without marking. No single call undoes it. Emits no webhook.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Responses

200

The number of notifications marked read.

NotificationMarkAllReadResult
{
  "data": {
    "affected": 2
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/notifications/actions/mark-all-read\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"