---
title: "Rooms"
slug: "rooms-api"
status: "update"
updated: 2026-09-14T20:10:30Z
published: 2026-09-14T20:10:30Z
canonical: "developer.rocket.chat/rooms-api"
---

> ## 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.

# Rooms

With the **Rooms API**, you can:

- Perform general room actions—send files, change settings, export room details, and more.
- Create and view room discussions.
- Mark a room as favorite, mute and unmute users, and view other details.

> [!NOTE]
> For details, you can refer to the [Room Options user guide](https://docs.rocket.chat/docs/room-actions).

## The room object

Rooms endpoints work with any room type through one shared object. A trimmed example from [Get Room Information](/apidocs/get-room-information):

```json
{
  "room": {
    "_id": "66ed2dba40141d95f32c292b",
    "name": "new-channel",
    "t": "p",
    "msgs": 3,
    "usersCount": 2,
    "u": { "_id": "C38WSSzrGd2NCjzqJ", "username": "test.cat" },
    "teamId": "66c82d78237405fc05fc1ef1",
    "ro": false,
    "default": false,
    "ts": "2024-09-20T08:09:30.417Z",
    "lm": "2024-09-20T12:27:53.356Z"
  },
  "success": true
}
```

Fields you use most often:

- `_id`: The room ID, passed as `roomId` in requests. Rooms endpoints identify rooms by ID, not name.
- `t`: The room type — `c` public channel, `p` private group, `d` direct message, `l` livechat. Rooms endpoints accept all types.
- `teamId`: Set when the room belongs to a team.
- `lm`: The timestamp of the last message.

## Common workflows

**Share a file in a room**

1. [Upload the media file](/apidocs/upload-media-files-to-a-room) to get a file ID.
2. [Send the uploaded file](/apidocs/check-uploaded-file) to the room as a message.
3. [Delete the uploaded file](/apidocs/delete-uploaded-file) if you need to withdraw it.

**Organize a busy room**

1. [Create a discussion](/apidocs/create-discussion) to branch a topic into its own room.
2. [Mark the room as favorite](/apidocs/favoriteunfavourite-a-room) and [tune its notifications](/apidocs/set-room-notifications).
3. [Mute a user](/apidocs/mute-user-in-room) who is disrupting the conversation.

**Clean up or retire a room**

1. [Clear room history](/apidocs/clear-room-history) for a time range, or [export the room](/apidocs/export-room) first to keep a record.
2. [Archive the room](/apidocs/change-room-archive-state), or [delete it](/apidocs/delete-room) permanently.

## Conventions

- These endpoints work across all room types. Type-specific management lives in the [Channels](/apidocs/channels-api), [Groups](/apidocs/groups-api), and [Teams](/apidocs/teams-api) APIs.
- Rooms endpoints identify rooms by `roomId`. Use [Get Rooms](/apidocs/get-rooms) to list the rooms you belong to and find IDs.
- Administrative actions such as clearing history or viewing any room require permissions like `clean-channel-history` or admin room access; each endpoint page lists its requirements.