Cleans up a room by removing messages from the provided time range. For details, see the Prune messages from a room section.
Permission required: clean-channel-history
Changelog
| Version | Description |
|---|---|
| 0.64.0 | Added |
| 0.67.0 | Added fields limit, excludePinned, filesOnly and users |
The authToken of the authenticated user.
The userId of the authenticated user.
{
"roomId": "roomId",
"latest": "2016-12-09T13:42:25.304Z",
"oldest": "2016-08-30T13:42:25.304Z"
}The room ID.
The end of time range of messages.
The start of the time range of messages.
Whether messages which land on the latest and oldest dates should be included. By default, the value is false.
Whether pinned messages should be deleted. By default, the value is false.
Whether to only delete files and keep messages intact. By default, the value is false.
Specific set of users whose content to delete. By default, the value is [], that is, everyone.
The amount of messages to prune. By default, the value is 0 (all).
Determines if messages from discussions should be pruned. By default, the value is true.
Determines if messages from threads should be pruned. By default, the value is true.
OK
{
"success": true
}Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}