---
title: "Export Room"
slug: "export-room"
updated: 2026-09-03T14:50:33Z
published: 2026-09-03T14:50:33Z
canonical: "developer.rocket.chat/export-room"
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.

# Export Room

Post/api/v1/rooms.export

Export room messages to a file or email. When exporting to a file, the ZIP file is stored in the `/tmp` directory on the Rocket.Chat server, and its details are recorded in the `rocketchat_user_data_files` collection in MongoDB.

Permission required: `mail-messages`

### Changelog

| Version | Description |
| --- | --- |
| 3.8.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='d58936d7-55d3-49ee-988c-fe6f0955ef9b'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='aaf6992d-2002-41d6-b6e4-4906f55d88ab'>Example</option>
</select>Example

```json
{
  "rid": "iu7jtPAhvEeAS5tNq",
  "type": "file",
  "dateFrom": "2000-01-01",
  "dateTo": "2021-11-25",
  "format": "html",
  "toUsers": [
    "test.user"
  ],
  "toEmails": [
    "test@test.com"
  ],
  "messages": [
    "yd6NBgNoiWATgDoFt",
    "BoCjicj9DdYoMHHeo",
    "tajMB3aX3sawFWe8W"
  ],
  "subject": "Test Subject "
}
```

object  ridstring    Required

The room ID.

typestring    Required

How you want the room to be exported. The type of export selected determines the remaining required parameters. It can be either `email` or `file`.

dateFromstring    

Start date to begin fetching. Use `dateFrom` if the type is `file`. By default, it selects the oldest possible date.

dateTostring    

End date for fetching. By default it selects the current date. Use `dateTo` if the `type` is `file`.

formatstring    

The file type to export as. It can either be `html` or `json`. Use `format` if the `type` is `file`.

toUsers Array of string   

An array of users that should recieve the export. ecieve the export. It is required if `type` is `email`.

string    
toEmails Array of string   

An array of any additional emails that should recieve the export. It is required if `type` is `email`.

string    
messages Array of string   

An array of messageId for the messages that should be exported. It is required if `type` is `email`.

string    
subjectstring    

The subject of the email. It is required if `type` is `email`.

Responses200

OK

<select class='api-response-data' aria-label='Media type'><option value='d677c7e4-5452-4554-80f1-69cade7fdb89'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='609e38ab-33e9-4368-990f-24211d05f380'>Success</option>
</select>Success

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

object  successboolean    

400

Bad Request

<select class='api-response-data' aria-label='Media type'><option value='d586b378-524c-4ba1-a8fc-88928bd81524'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='248dc566-f353-4558-830b-fc7bc2645bae'>Invalid Room ID</option>
<option value='d510bae0-60d0-4929-a3cc-29e0f96da42c'>Invalid Format</option>
<option value='8b5ac6f6-9c91-4e2d-af88-d664c9d21b03'>Invalid Params</option>
</select>Invalid Room ID

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

Invalid Format

```json
{
  "success": false,
  "error": "[error-invalid-format]",
  "errorType": "error-invalid-format"
}
```

Invalid Params

```json
{
  "success": false,
  "error": "[error-invalid-params]",
  "errorType": "error-invalid-params"
}
```

object  successboolean    
errorstring    
errorTypestring    

401

Unauthorized

<select class='api-response-data' aria-label='Media type'><option value='a24ad05c-e15a-41bd-b79c-f2a628888bea'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='184e10cd-3cee-41e8-bc72-50dfcab0a033'>Authorization Error</option>
</select>Authorization Error

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

object  statusstring    
messagestring    

403

Forbidden

<select class='api-response-data' aria-label='Media type'><option value='ab285f28-0862-40b3-96cb-66bb12850038'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='ee2fbfda-14a0-4139-98bb-9be3a45cf47e'>Permission Error</option>
</select>Permission Error

```json
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
```

object  successboolean    
errorstring