WhatsApp Gateway
API referenceChannels

Mute or unmute a channel

POST
/api/v1/sessions/{session}/channels/{jid}:mute

Set channel mute state for this session. Omit body or mute for default mute=true.

Current behavior is not_implemented (501); no state change happens yet.

Requires send capability.

Returns 204 when supported.

Errors: forbidden (403), not_found (404), not_implemented (501).

Authorization

AuthorizationBearer <token>

Send Authorization: Bearer <token>. The token can be a login JWT from the frontend or an api-key for a script. JWT access comes from the person's organization role. Api-key access comes from the permissions saved on the key.

In: header

Path Parameters

session*string

Session ID whose channel mute flag is being updated.

Example"01HX..."
jid*string

Channel JID, for example 120363012345678901@newsletter.

Example"120363012345678901@newsletter"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

mute?boolean

Mute state: true mutes, false unmutes. Empty body defaults to mute=true.

Exampletrue

Response Body

application/json

curl -X POST "https://example.com/api/v1/sessions/01HX.../channels/120363012345678901@newsletter:mute" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{  "error": {    "code": "not_found",    "details": {      "property1": null,      "property2": null    },    "message": "session not found"  }}