Group Rename

Changes the name of the private group.
URL
Requires Auth
HTTP Method
/api/v1/groups.rename
yes
POST
Payload
Argument
Example
Required
Description
roomId
ByehQjC44FwMeiLbX
Required
The private group's id
name
new-name
Required
The new name the private group will have, it can not 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/groups.rename \
     -d '{ "roomId": "ByehQjC44FwMeiLbX", "name": "new-name" }'
Example Result
{
  "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

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

Argument	Example	Required	Description
`roomId`	`ByehQjC44FwMeiLbX`	Required	The private group's id
`name`	`new-name`	Required	The new name the private group will have, it can not be the same as another or the existing name

Version	Description
0.48.0	Added

Group Remove Owner

Group Set Announcement

Last modified 10mo ago