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

use GetStream\ChatClient;
use GetStream\GeneratedModels as Models;

$client = new ChatClient("{{ api_key }}", "{{ api_secret }}");

$client->truncateChannel("messaging", "general", new Models\TruncateChannelRequest());

// Or with parameters:
$client->truncateChannel("messaging", "general", new Models\TruncateChannelRequest(
    message: new Models\MessageRequest(
        text: "Dear Everyone. The channel has been truncated.",
        userID: $userId,
    ),
    skipPush: true,
));

Truncate Options

FieldTypeDescriptionOptional
truncated_atDateTruncate messages up to this time
user_idstringUser who performed the truncation (server-side only)
messageobjectA system message to add after truncation
skip_pushboolDo not send a push notification for the system message
hard_deleteboolPermanently delete messages instead of hiding them