Room membership
Stop the requesting user remembering about a particular room.
This API stops a user remembering about a particular room.
In general, history is a first class citizen in Matrix. After this API is called, however, a user will no longer be able to retrieve history for this room. If all users on a homeserver forget a room, the room is eligible for deletion from that homeserver.
If the user is currently joined to the room, they must leave the room before calling this API.
post/_matrix/client/v3/rooms/{roomId}/forget
Request
- Base URLhttps://matrix.org
- Auth
- API key in query parameter access_token
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
roomIdstring mx-room-id required
The room identifier to forget.
Response
The room has been forgotten.
object required
Changes
No recorded changes to this operation across all 1 revision of this API.