2020-12-10 04:42:48 -07:00
|
|
|
Deprecated: Purge room API
|
|
|
|
|
==========================
|
|
|
|
|
|
|
|
|
|
**The old Purge room API is deprecated and will be removed in a future release.
|
|
|
|
|
See the new [Delete Room API](rooms.md#delete-room-api) for more details.**
|
2019-08-22 03:42:59 -06:00
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
The API is:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
POST /_synapse/admin/v1/purge_room
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
"room_id": "!room:id"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
You must authenticate using the access token of an admin user.
|
