Archive Rooms (Realtime)

Prev Next

When a room is archived, it is designated as read-only and removed from the channel list on the left sidebar.

Method

Requires Auth

Permission

archiveRoom

Yes

archive-room

Payload parameters

Argument

Example

Required

Description

roomId

64a1f373376181965ab77f54

Required

The room ID.

Example call

{
    "msg": "method",
    "method": "archiveRoom",
    "id": "3",
    "params": [
        "64a1f373376181965ab77f54"
    ]
}

Example response

{
    "msg": "result",
    "id": "3"
}