Clean Room History
REST API Clean History Methods
Cleans up a room, removing messages from the provided time range.
URL | Requires Auth | HTTP Method |
|---|---|---|
/api/v1/rooms.cleanHistory | yes | POST |
Argument | Example | Required | Description |
|---|---|---|---|
roomId | ByehQjC44FwMeiLbX | Required | The room's id |
latest | 2016-09-30T13:42:25.304Z | Required | The end of time range of messages to clean |
oldest | 2016-05-30T13:42:25.304Z | Required | The start of the time range of messages to clean |
inclusive | true | Optional Default: false | Whether messages which land on latest and oldest should be included |
excludePinned | true | Optional Default: false | Whether pinned messages should be deleted |
filesOnly | true | Optional Default: false | Whether to only delete files and keep messages intact |
users | ["vynmera", "ggazzo"] | Optional Default: [] (everyone) | Specific set of users whose content to delete |
limit | 10 | Optional Default: 0 (all) | The amount of messages to prune |
ignoreDiscussion | true | Optional Default: true | Determines if messages from discussions should be pruned |
ignoreThreads | true | Optional Default: true | Determines if messages from threads should be pruned |
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
-H "Content-type: application/json" \
http://localhost:3000/api/v1/rooms.cleanHistory \
-d '{ "roomId": "roomId", "latest": "2016-12-09T13:42:25.304Z", "oldest": "2016-08-30T13:42:25.304Z" }'
{
"success": true
}
Version | Description |
|---|---|
0.64.0 | Added |
0.67.0 | Added fields limit, excludePinned, filesOnly and users |
Last modified 1yr ago