Truncate Channel

Truncating a channel removes all messages but preserves the channel data and members. To delete both the channel and its messages, use Delete Channel instead.

Truncation can be performed client-side or server-side. Client-side truncation requires the TruncateChannel permission.

On server-side calls, use the user_id field to identify who performed the truncation.

By default, truncation hides messages. To permanently delete messages, set hard_delete to true.

Truncate a Channel

from getstream.models import MessageRequest

# Get a channel
channel = client.chat.channel("messaging", "general")

channel.truncate()

# Or with parameters:
channel.truncate(
    hard_delete=True,
    skip_push=True,
    message=MessageRequest(
        text="Dear Everyone. The channel has been truncated.",
        user_id=random_user["id"],
    ),
)

Truncate Options