Room participation

Strips all non-integrity-critical information out of an event.

Strips all information out of an event which isn't critical to the integrity of the server-side representation of the room.

This cannot be undone.

Any user with a power level greater than or equal to the m.room.redaction event power level may send redactions for their own events in the room. If the user's power level is also greater than or equal to the redact power level of the room, the user may redact events sent by other users.

Server administrators may redact events sent by users on their server.

put/_matrix/client/v3/rooms/{roomId}/redact/{eventId}/{txnId}

Request

Base URL
https://matrix.org
Auth
- API key in query parameter access_token
- or HTTP bearer
TypeScript
https://skmtc.dev/matrix/apis/matrix-client-server-api/docs/_matrix/client/v3/rooms/:roomId/redact/:eventId/:txnId/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

roomIdstring mx-room-id required

The room from which to redact the event.

eventIdstring mx-event-id required

The ID of the event to redact.

txnIdstring required

The transaction ID for this event. Clients should generate a unique ID; it will be used by the server to ensure idempotency of requests.

Request body

reasonstring

The reason for the event being redacted.

Example request

{
  "reason": "Indecent material"
}

Response

An ID for the redaction event.

event_idstring mx-event-id

A unique identifier for the event.

Changes

No recorded changes to this operation across all 1 revision of this API.