Documentation

Channel Close

Removes the channel from the user’s list of channels.

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

Payload

| Argument | Example | Required | Description | | :— | :— | :— | :— | | roomId | ByehQjC44FwMeiLbX | Required | The channel’s id |

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type: application/json" \
     http://localhost:3000/api/v1/channels.close \
     -d '{ "roomId": "ByehQjC44FwMeiLbX" }'

Example Result

{
   "success": true
}

Change Log

| Version | Description | | :— | :— | | 0.48.0 | Added |