Skip to main content

Put Update Channel


https://api.deadsimplechat.com/consumer/api/v1/chatroom/:roomId/channel/:channelId

Put Update Channel

This endpoint allows you to update the channel for a specific chatroom

info

The auth query parameter is your private key. You can find it in your Dashboard under Developer -> Private Key.

Update ChannelsDescription
Parameters
Path
channelIdstringid of the channel
roomIdstringroomId where the channel is present
Query
authstringGo to Dashboard -> Developer -> Private Key is your auth
Body
enabledbooleanSet Channel to enabled or disabled
notifyAllUsersbooleanNotify all users in the channel when a message is sent to the channel
channelNamestringName of the Channel
metadatastringMetadata of the channel (maximum length: 1000 characters)

Responses

200

JSON

{
"_id": "61141f7a40801b21ee2c624d",
"channelName": "coolBond",
"enabled": false,
"notifyAllUsers": false,
"roomId": "HTqSW_9-t"
}

400

JSON

{
"message": "channel not found"
}

401

JSON

{
"message": "Invalid auth token"
}