Freeze a community channel

Set the freeze status for a specified community channel or subchannel. Supports both freezing and unfreezing.

• Freezing a community channel prevents all members from sending messages to the community channel and its subchannels via client SDK.
• Freezing a subchannel prevents all members from sending messages to that subchannel via client SDK.

tip

• The freeze status persists even if the community channel or subchannel is dismissed and recreated.
• Server API message sending is not restricted by freeze status. Users can still send messages via Server API.

To allow specific users to send messages while frozen, use the allowed senders list. See 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/freeze-list/set

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.
status	Boolean	Yes	true = frozen. false = unfrozen.

Request example

HTTP

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

{
    "channelId": "abcdefg",
    "status": true
}

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}