---
title: "Rename Group"
slug: "rename-group"
updated: 2026-06-08T12:46:40Z
published: 2026-06-08T12:46:40Z
stale: true
---

> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# Rename Group

Post/api/v1/groups.rename

Rename a private channel. Permission required: `edit-room`

### Changelog

| Version | Description |
| --- | --- |
| 0.48.0 | Added |

Header parametersX-Auth-TokenstringRequired

The `authToken` of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-IdstringRequired

The `userId` of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ

Body parameters<select class='api-response-data' aria-label='Media type'><option value='eaf4c2fa-b9dd-485b-b1a0-dea4ad365a6e'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='1d1a73b0-3118-415c-ad3c-7089fe0d728c'>Example</option>
</select>Example

```json
{
  "roomId": "ByehQjC44FwMeiLbX",
  "name": "new-name"
}
```

object  roomIdstring    Required

The private group's ID. You can find the IDs by using any of the following endpoints:

- [Get List of User Groups](https://developer.rocket.chat/apidocs/get-list-of-user-groups): This endpoint returns all private channels in the workspace, if you have the required permissions to view them.
- [Get Groups](https://developer.rocket.chat/apidocs/get-groups): This endpoint returns the private channels that you are a member of.

ExampleByehQjC44FwMeiLbX
namestring    Required

The new name of the private group. It can not be the same as another or the existing name.

Examplenewname

Responses200

OK

<select class='api-response-data' aria-label='Media type'><option value='05c69714-2950-4e0a-9365-2f9b691253de'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='18ca7129-c51f-47fd-b147-a60aacb2d437'>Success</option>
</select>Success

```json
{
  "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
}
```

Expand Allobject  groupobject  _idstring    
namestring    
tstring    
usernames Array of string   string    
msgsinteger    
uobject  _idstring    
usernamestring    

tsstring    
roboolean    
sysMesboolean    
_updatedAtstring    

successboolean    

400

Bad Request

<select class='api-response-data' aria-label='Media type'><option value='45f18350-3414-41e4-b2ee-6c4c87fb004a'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='19d63de3-7a1d-4798-9d15-f5f300d06c2e'>Example 1</option>
<option value='d7f3f28f-7fb8-464d-b011-db03ee937dc5'>Example 2</option>
</select>Example 1

```json
{
  "success": false,
  "error": "The bodyParam \"name\" is required"
}
```

Example 2

```json
{
  "success": false,
  "error": "The parameter \"roomId\" or \"roomName\" is required [error-room-param-not-provided]",
  "errorType": "error-room-param-not-provided"
}
```

object  successboolean    
errorstring    

401

Unauthorized

<select class='api-response-data' aria-label='Media type'><option value='0ae2b693-61b3-47e8-9674-563ac0a1ffa8'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='65a5b459-adf3-4d84-8ff1-81bd15be9bb7'>Authorization Error</option>
</select>Authorization Error

```json
{
  "status": "error",
  "message": "You must be logged in to do this."
}
```

object  statusstring    
messagestring