0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-24 12:54:15 +01:00
synapse/docs/admin_api/purge_room.md

22 lines
492 B
Markdown
Raw Normal View History

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 11:42:59 +02: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.