forked-synapse/docs/admin_api/purge_room.md

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.**

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.
Deprecate Shutdown Room and Purge Room Admin API (#8829) Deprecate both APIs in favour of the Delete Room API. Related: #8663 and #8810 2020-12-10 06:42:48 -05: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.**`
Servlet to purge old rooms (#5845) 2019-08-22 05:42:59 -04: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.`