Reset chat history
PUT {{baseUrl}}/v3/group_channels/:channel_url/reset_user_history
Reset chat history
Resets the properties related to a user's chat history in a group channel, then clears the existing messages in the channel on the user's side only. A user can no longer see the messages in a group channel once this action is called, but those messages are not deleted from the database of the Sendbird system. All other members in the channel can retrieve and see the messages.
This action simply clears the messages for the user by updating the last_message
and read_receipt
properties of the channel resource in addition to other internally managed data such as the number of the user's unread message.
Using the reset_all
property, you can also reset the properties related to all users' chat history in a group channel.
https://sendbird.com/docs/chat/v3/platform-api/guides/group-channel#2-reset-chat-history
Request Body
{"channel_url"=>"<string>", "user_id"=>"<string>", "reset_all"=>"<boolean>"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Api-Token | string | (Required) | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"ts_message_offset":"\u003cnumber\u003e"}