Actions60
- User Actions
- Channel Actions
- Accept Invite
- Add Members
- Add Moderators
- Archive
- Ban User
- Create
- Delete
- Delete File
- Delete Image
- Demote Moderators
- Disable Slow Mode
- Enable Slow Mode
- Get Config
- Hide
- Invite Members
- Mark Read
- Mark Unread
- Mute
- Mute Status
- Pin
- Query Channels
- Query Members
- Reject Invite
- Remove Members
- Send Action
- Send File
- Send Image
- Show
- Stop Watching
- Truncate
- Unarchive
- Unban User
- Unmute
- Unpin
- Update
- Watch
- Message Actions
- Moderation Actions
Channel → Truncate
AI-generatedSummary
Remove all messages from a specified Stream Chat channel, optionally using advanced truncation options.
Inputs
- Channel Type — The type of the channel, e.g., "messaging" for 1-on-1 chats, "team" for group channels, or "livestream" for broadcast channels. Defaults to "messaging".
- Channel ID (required) — Unique identifier for the channel to truncate (e.g., "general", "random", "team-alpha"). Combined with Channel Type to identify the channel.
- Truncate Options — A JSON object specifying additional options for truncating the channel, such as {"hard_delete": true, "skip_push": false} to control deletion behavior and push notifications.
Output shape
a single JSON object representing the result of the truncate operation from the Stream Chat API
The output contains the API response confirming the truncation. If the operation fails, an error is returned. The truncate options JSON can customize the truncation process per Stream Chat API specification.