Actions53
- Channel Actions
- Direct Message Actions
- Message Actions
- User Actions
Channel → Archive
AI-generatedSummary
Archive a channel
Inputs
- channelType — Whether to target a public channel or a private group
- specifyRoomManually — Whether to specify the room ID manually instead of selecting from the list
- roomId (required) — Select the channel from the list or enter the ID manually
Output shape
a single object representing the archived channel (the API response)
Fields vary by Rocket.Chat; typically includes identifiers and status. Errors are thrown unless continueOnFail is enabled.
Examples
Example 1: Archive a public channel by ID
channelType = Public Channel; specifyRoomManually = false; roomId = abc123