Rocket.Chat Extended icon

Rocket.Chat Extended

Extended Rocket.Chat operations: channels, messages, threads, reactions, file upload, and more

Channel → Set Description

AI-generated

Summary

Set the description of a selected 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. Choose from the list, or switch to manual mode to enter the ID.
  • description (required) — The new description for the channel

Output shape

a single channel object

Contains at least the channel ID and updated description; may include additional metadata depending on server response.

Examples

Example 1: Update a public channel's description

channelType = Public Channel, specifyRoomManually = false, roomId = , description = "Community announcements"

Example 2: Update a private group's description using manual ID

channelType = Private Group, specifyRoomManually = true, roomId = , description = "Important updates"

Links

Discussion