Skip to main content

Create Channel


https://api.deadsimplechat.com/consumer/api/v1/chatroom/:roodId/channel

Create Channel

info

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

Create a Channel Inside of a Chat Room

ParametersDescription
Path
roomIdstringroomId of the chat room where you want to create the channel
Query
authstringGo to Dashboard -> Developer -> Private Key is your auth room
Body
enabledbooleanset the channel enabled or disabled
notifyAllUsersbooleanWhenever a message is sent to this channel do you want to notify all users in the chant room. If this is set to true all users in the chatroom will be notified even if they have never opened the channel, if this is set to false then only the users who have open the channel will be notified of the new messages.
channelNamestringname of the channel
metadatastringmetadata of the channel (maximum length: 1000)

Responses

200

JSON
{
"_id": "65ea3ac1861e60c09f805871",
"channelName": "myChannel",
"enabled": true,
"metadata": "abcpqe",
"notifyAllUsers": false,
"roomId": "MG99xw-79"
}

404

JSON

{
"message": "Invalid auth token"
}