Channel Rename

Changes the name of the channel.

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


Argument Example Required Description
roomId ByehQjC44FwMeiLbX Required The channel’s id
name new-name Required The new name the channel will have, it cannot be the same as another or the existing name

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.rename \
     -d '{ "roomId": "ByehQjC44FwMeiLbX", "name": "new-name" }'

Example Result

  "channel": {
    "_id": "ByehQjC44FwMeiLbX",
    "name": "new-name",
    "t": "c",
    "usernames": [
    "msgs": 4,
    "u": {
      "_id": "aobEdbYhXfu5hkeqG",
      "username": "testing1"
    "ts": "2016-12-09T15:08:58.042Z",
    "ro": false,
    "sysMes": true,
    "_updatedAt": "2016-12-09T15:57:44.686Z"
  "success": true

Change Log

Version Description
0.48.0 Added

Table of contents