---
title: "Rename a Channel"
slug: "rename-a-channel"
updated: 2026-06-01T06:32:04Z
published: 2026-06-01T06:32:04Z
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 a Channel

Post/api/v1/channels.rename

Change the name of a 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='70299142-9d60-4a4d-b03e-f8cc1cb563a7'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='2f9feb46-d18a-40e0-ad84-5e15c167ffee'>Example</option>
</select>Example

```json
{
  "roomId": "WDuJLFkjwk6L7LdFC",
  "name": "newName"
}
```

object  roomIdstring    Required

The channel's ID.

namestring    Required

The new name of the channel. It can not be the same as the current name.

Responses200

OK

<select class='api-response-data' aria-label='Media type'><option value='11ca03e2-c12c-4a36-be86-0f0ecf61bc08'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='302df114-2b17-4f96-a9bd-7fdc7f98ad2d'>Success</option>
</select>Success

```json
{
  "channel": {
    "_id": "ByehQjC44FwMeiLbX",
    "name": "new-name",
    "t": "c",
    "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  channelobject  _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='80b0f271-8f5b-4398-ad72-277818c6390b'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='beab380a-79cf-48c5-a2bf-1f6760248f37'>No permission</option>
</select>No permission

```json
{
  "success": false,
  "error": "Editing room is not allowed [error-action-not-allowed]",
  "errorType": "error-action-not-allowed",
  "details": {
    "method": "saveRoomSettings",
    "action": "Editing_room"
  }
}
```

Expand Allobject  successboolean    
errorstring    
errorTypestring    
detailsobject  methodstring    
actionstring    

401

Unauthorized

<select class='api-response-data' aria-label='Media type'><option value='6bc9f4c4-1db9-40b7-aa72-55429b9d1877'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='e2cdd981-fe0c-4579-8a30-8c7d950838ef'>Authorization Error</option>
</select>Authorization Error

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

object  statusstring    
messagestring