Mute or unmute a channel
POST/api/sessions/:sessionId/channels/:channelId/mute
Silences the channel's notifications for this account. The subscription is untouched.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 503
Channel muted or unmuted
Session not started, or validation failed
The API key is missing, unknown, revoked, or expired
The engine refused. Also returned when the API key's role, session or chat scope, or IP allow-list does not allow this operation.
The id is not a channel id (it does not end in @newsletter). Retrying the same id cannot succeed. On whatsapp-web.js, also answered for a channel id that is not among the session's subscribed channels or has not synced into the local collection yet.
The session is not connected: an engine exists for it but is not ready, meaning disconnected, reconnecting, or still initializing, so the request never reached WhatsApp. Wait for ready and retry. A send whose first attempt had already run when the session left ready (or WhatsApp Web reloaded its page) is the exception: it answers a 409 with no code that says the message may or may not have been sent, so check the chat before sending it again (a retry with the same Idempotency-Key answers IDEMPOTENCY_OUTCOME_UNKNOWN). A session that was never started answers 400 instead, and the session lifecycle routes answer 409 for a conflicting state rather than this. One window answers this while the session still reads ready: WhatsApp Web periodically reloads its own page and the engine re-injects into it, and until it has the answer is a 409 naming the reload, with code ENGINE_PAGE_RELOADING and retryAfterSeconds. That takes seconds on most reloads and can take a few minutes, and no event marks its end: ask again at that interval.
WhatsApp did not answer within the request budget — the operation may or may not have applied. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause. On whatsapp-web.js, also when WhatsApp Web reports a timeout, a rate limit or a server error (408, 423, 429 or 5xx): that report does not say whether the operation was applied, so it may or may not have been applied; check before repeating it.