PATCH
Toggle notification mute

Overview

Sets the user’s notificationsMuted boolean. The push-delivery worker consults this flag on every job and skips the send entirely when it’s true — except for jobs with kind: 'critical' (account banned, security alerts, etc.), which bypass the mute. See Push notification fan-out — Mute semantics for the precedence rules.
This is a global mute, not per-conversation. Per-conversation mutes are deferred to a later phase; the data model already has the user-side flag but no UI granularity exists today.

Authentication

Bearer <accessToken> required. requireAuth + requireOnboarded middleware applied.

Path parameters

None.

Query parameters

None.

Request body

Example payload

Response — 200 OK

What the mute affects

The mute is enforced at the worker layer, not the producer layer. Producers (chat / match / tenancy services) still enqueue the jobs unconditionally — this keeps the producers cheap and lets a future “show in-app inbox even while muted” feature share the same pipeline.

Side effects

  • Sets the user’s notificationsMuted field to the new value.
  • Does NOT cancel already-enqueued push jobs. A burst of messages delivered to BullMQ just before the user mutes may still result in 1–2 already-claimed jobs running, but they’ll be dropped at the worker’s mute check.

Error responses

Example error — 400 VALIDATION_FAILED

See also

curl