---
title: "Change Room Archive State"
slug: "change-room-archive-state"
updated: 2026-09-03T14:50:33Z
published: 2026-09-03T14:50:33Z
canonical: "developer.rocket.chat/change-room-archive-state"
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.

# Change Room Archive State

Post/api/v1/rooms.changeArchivationState

Archive or unarchive a room. Permissions required:

- `archive-room`: To archive a room.
- `unarchive-room`: To unarchive a room.

### Changelog

| Version | Description |
| --- | --- |
| 3.3.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='28cd0073-b3da-4924-922f-f4fddb3fe5d6'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='f2c0cd76-87ea-4189-9109-79f65b8bd12b'>Example</option>
</select>Example

```json
{
  "rid": "iu7jtPAhvEeAS5tNq",
  "action": "archive"
}
```

object  ridstring    Required

The room Id.

actionstring    Required

It can either be archive or otherwise unarchived.

Responses200

OK

<select class='api-response-data' aria-label='Media type'><option value='fc5e7a45-5ef5-43ed-839f-6bf51fa87444'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='6509163e-baf6-4882-a40c-d16ab76bd3ea'>Success</option>
</select>Success

```json
{
  "success": true
}
```

object  successboolean    

400

Bad Request

<select class='api-response-data' aria-label='Media type'><option value='4549aae8-d016-4eb1-9b61-44ef538be3d7'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='f0eae207-d450-477d-855c-fa4c912c299f'>Invalid Room</option>
</select>Invalid Room

```json
{
  "success": false,
  "error": "Invalid room [error-invalid-room]",
  "errorType": "error-invalid-room",
  "details": {
    "method": "unarchiveRoom"
  }
}
```

Expand Allobject  successboolean    
errorstring    
errorTypestring    
detailsobject  methodstring    

401

Unauthorized

<select class='api-response-data' aria-label='Media type'><option value='49d0be10-f359-49a5-aa90-cc2f55b94933'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='59ce1943-4a6c-4f7d-bd58-699e24f5813a'>Authorization Error</option>
</select>Authorization Error

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

object  statusstring    
messagestring