Mute community channel members

Mute one or more users in a specified community channel, a specific subchannel, or across all subchannels.

• Muting a user at the community channel (channelId) level prevents them from sending messages via client SDK to the community channel and all its subchannels. Muting at the subchannel (subchannelId) level prevents sending in that specific subchannel only.
• Server API message sending is not restricted by mute status. Muted users can still send messages via Server API.
• Mute data is not cleared when a user leaves a community channel. If a muted user leaves and rejoins, the mute remains in effect.
• To mute a user across all subchannels, omit the subchannel ID (pass subchannelId as empty). Up to 100 users per App Key can be muted across all subchannels. To check whether you've reached the limit, call the Query muted members list API with subchannelId empty.

tip

If your app uses individual muting, freeze, and allowed senders list features together (at community channel or subchannel level), see the Combining mute and allowed senders list section in Add to allowed senders list.

If API behavior does not match expectations, see Legacy mute behavior.

Request method

POST: https://Base URL/v4/community-channel/mute-list/add

Rate limit: 100 requests per second

Signature required: All server API requests require signature verification. See API request signature.

Request body

The request body is in application/json format and supports the following parameters:

Parameter	Type	Required	Description
channelId	String	Yes	The community channel ID.
subchannelId	String	No	The subchannel ID.
userIds	String[]	Yes	List of user IDs to mute. Maximum 20 per request.

Request example

HTTP

POST /v4/community-channel/mute-list/add HTTP/1.1
Host: api.sg-light-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json

{
  "channelId": "abcdefg",
  "userIds": ["userId_001", "userId_002"]
}

Response

The response body contains a JSON object with the following structure:

Field	Type	Description
code	Number	Status code. 0 indicates success.

Response example

HTTP

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":0}