delete-channel.md

Delete Channel

Remove a public channel.

HTTP Method	URL	Requires Auth
POST	/api/v1/channels.delete	yes

Body Parameters

Key	Example Value	Description
roomId* or roomName*	ByehQjC44FwMeiLbX or general	The channel ID or name that you want to delete. You must enter at least one of the parameters.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type: application/json" \
     https://localhost:3000/api/v1/channels.delete \
     -d '{ 
          "roomName": "channelname" }'

Example Response

{
   "success": true
}

Change Log

Version	Description
0.71.0	Removed channel property
0.49.0	Added