Room membership

Unban a user from the room.

Unban a user from the room. This allows them to be invited to the room, and join if they would otherwise be allowed to join according to its join rules.

The caller must have the required power level in order to perform this operation.

post/_matrix/client/v3/rooms/{roomId}/unban

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/unban/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

roomIdstring mx-room-id required

The room identifier (not alias) from which the user should be unbanned.

Request body

reasonstring

Optional reason to be included as the reason on the subsequent membership event.

user_idstring mx-user-id required

The fully qualified user ID of the user being unbanned.

Example request

{
  "reason": "They've been banned long enough",
  "user_id": "@cheeky_monkey:matrix.org"
}

Response

The user has been unbanned from the room.

object required

Changes

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