Delete a subchannel

Delete a subchannel from a specified community channel. After deletion, users can no longer send messages in this subchannel.

• Message history in the subchannel is preserved. To restore a deleted subchannel, call the create subchannel API with the same subchannel ID.
• Deleting a subchannel also removes its private subchannel member list.

Request method

POST: https://Base URL/v4/community-channel/subchannel/delete

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	Yes	The subchannel ID. Supports uppercase and lowercase letters and numbers. Maximum 20 characters.

Request example

HTTP

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

{
    "channelId": "abcdefg",
    "subchannelId": "channel001"
}

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}