diff options
| author | Richard van der Hoff <richard@matrix.org> | 2018-05-03 14:59:29 +0100 |
|---|---|---|
| committer | Richard van der Hoff <richard@matrix.org> | 2018-05-03 14:59:29 +0100 |
| commit | 093d8c415a303fa7c8900e3fe685843b60a85eed (patch) | |
| tree | 8dd5ceabb4c8ecbae18fa95f10108ba335c6bbbf /docs/admin_api | |
| parent | Make 'unexpected logging context' into warnings (diff) | |
| parent | Merge pull request #3183 from matrix-org/rav/moar_logcontext_leaks (diff) | |
| download | synapse-093d8c415a303fa7c8900e3fe685843b60a85eed.tar.xz | |
Merge remote-tracking branch 'origin/develop' into rav/warn_on_logcontext_fail
Diffstat (limited to 'docs/admin_api')
| -rw-r--r-- | docs/admin_api/purge_history_api.rst | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/admin_api/purge_history_api.rst b/docs/admin_api/purge_history_api.rst index ea2922da5c..2da833c827 100644 --- a/docs/admin_api/purge_history_api.rst +++ b/docs/admin_api/purge_history_api.rst @@ -16,9 +16,11 @@ including an ``access_token`` of a server admin. By default, events sent by local users are not deleted, as they may represent the only copies of this content in existence. (Events sent by remote users are -deleted, and room state data before the cutoff is always removed). +deleted.) -To delete local events as well, set ``delete_local_events`` in the body: +Room state data (such as joins, leaves, topic) is always preserved. + +To delete local message events as well, set ``delete_local_events`` in the body: .. code:: json |