rename-group.md

Rename Group

Changes the name of the group/channel.

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

Body Parameters

Key	Example Value	Description
roomId*	ByehQjC44FwMeiLbX	The group ID.
name*	new-name	The new name of the group. It can not be the same as another group 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/groups.rename \
     -d '{ 
          "roomId": "ByehQjC44FwMeiLbX", 
          "name": "new-name" }'

Example Response

{
  "group": {
    "_id": "ByehQjC44FwMeiLbX",
    "name": "new-name",
    "t": "p",
    "usernames": [
      "testing1"
    ],
    "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