mx_redact: Redact an event

In mx.api: Minimal Matrix Client-Server API

Redact an event

Description

Removes the content of a message, reaction, or other event. This is how Matrix deletes things.

Usage

mx_redact(session, room_id, event_id, reason = NULL, txn_id = NULL)

Arguments

session	An "mx_session" object.
room_id	Character. The room ID.
event_id	Character. The event to redact.
reason	Character or NULL. Optional human-readable reason.
txn_id	Character or NULL. Transaction id (generated if NULL).

Value

The event ID of the redaction event.

Examples

## Not run: 
mx_redact(s, "!abc:example", "$someevent", reason = "typo")

## End(Not run)

mx.api documentation built on Sept. 12, 2026, 1:07 a.m.