---
title: "Change Room Archive State"
slug: "change-room-archive-state"
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.

# 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='c8ff84ef-33bd-42d6-86bc-7508fe37fe8f'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='ddcf9b7c-d981-496b-90be-47a8bb7a35c4'>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='79b27d0a-7816-4b97-b2b7-2d1c0e87e69d'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='f7f57101-9390-48ee-b69a-d4fc9ec8cc3e'>Success</option>
</select>Success

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

object  successboolean    

400

Bad Request

<select class='api-response-data' aria-label='Media type'><option value='5072cee2-cf0e-423f-945c-6d02c2a3d6d7'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='366ef8cf-26ea-4ccd-9582-9ab9ad1f88c8'>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='9a251be7-e0c1-4165-b0f5-4622eac83431'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='28bb8968-836f-4e17-8e34-b21188f2f114'>Authorization Error</option>
</select>Authorization Error

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

object  statusstring    
messagestring