---
title: "Set Channel ReadOnly"
slug: "set-channel-readonly"
updated: 2026-09-03T14:50:33Z
published: 2026-09-03T14:50:33Z
canonical: "developer.rocket.chat/set-channel-readonly"
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.

# Set Channel ReadOnly

Post/api/v1/channels.setReadOnly

Set a channel to be read-only or not. Permission required: `edit-room`

### Changelog

| Version | Description |
| --- | --- |
| 0.49.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='ffe746db-bff4-47ff-8873-f64554c5dc3a'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='3eaf1da3-c1fc-4380-bd63-9ea617a49642'>Example</option>
</select>Example

```json
{
  "roomId": "ByehQjC44FwMeiLbX",
  "readOnly": true
}
```

object  roomIdstring    Required

The channel ID.

readOnlyboolean    Required

Boolean of whether the room is read-only or not.

Responses200

OK

<select class='api-response-data' aria-label='Media type'><option value='9ab8fb75-d039-4789-b739-3a75d472e419'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='5ef650cb-f4bf-43ae-978f-1a4dc5130dbb'>Success</option>
</select>Success

```json
{
  "channel": {
    "_id": "ByehQjC44FwMeiLbX",
    "name": "testing0",
    "t": "c",
    "msgs": 0,
    "u": {
      "_id": "aiPqNoGkjpNDiRx6d",
      "username": "goose160"
    },
    "ts": "2017-01-05T18:02:50.754Z",
    "ro": true,
    "sysMes": true,
    "_updatedAt": "2017-01-05T19:02:24.429Z",
    "usernames": [
      "goose160",
      "graywolf336"
    ],
    "joinCodeRequired": true,
    "muted": []
  },
  "success": true
}
```

Expand Allobject  channelobject  _idstring    
namestring    
tstring    
msgsinteger    
uobject  _idstring    
usernamestring    

tsstring    
roboolean    
sysMesboolean    
_updatedAtstring    
usernames Array of string   string    
joinCodeRequiredboolean    
muted Array of object   object  

successboolean    

401

Unauthorized

<select class='api-response-data' aria-label='Media type'><option value='2699b25e-9978-4419-a3d1-2bceea1a902a'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='c6bad73f-4cf5-4df6-b497-32e2fae7ffbe'>Authorization Error</option>
</select>Authorization Error

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

object  statusstring    
messagestring