Actions53
- Channel Actions
- Direct Message Actions
- Message Actions
- User Actions
Channel → Set Announcement
AI-generatedSummary
Set the announcement of a channel or group.
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 (when specifyRoomManually is false).
- roomId (required) — Enter the channel or group ID manually (when specifyRoomManually is true).
- announcement (required) — The announcement text to set for the channel.
Output shape
a single channel object
Contains the updated channel's fields (e.g., _id, announcement). No pagination; empty response on error when continueOnFail is disabled.
Examples
Example 1: Set announcement for a public channel using the channel dropdown
Channel Type = Public Channel; select Room from list; Announcement = "Welcome to our channel"
Example 2: Set announcement for a private group using manual room ID
specifyRoomManually = true; Room ID = "abc123"; Announcement = "Group update"
Example 3: Set announcement without changing channel type
Leave Channel Type as default; select Room; Announcement = "New rules"