summary refs log tree commit diff
path: root/docs/admin_api/purge_room.md
blob: ae01a543c6047efdf7f836744d36f9ebf8b93cde (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
Purge room API
==============

This API will remove all trace of a room from your database.

All local users must have left the room before it can be removed.

See also: [Delete Room API](rooms.md#delete-room-api)

The API is:

```
POST /_synapse/admin/v1/purge_room

{
    "room_id": "!room:id"
}
```

You must authenticate using the access token of an admin user.