MAmatrix
Room membership

Join the requesting user to a particular room.

Note that this API takes either a room ID or alias, unlike /rooms/{roomId}/join.

This API starts a user's participation in a particular room, if that user is allowed to participate in that room. After this call, the client is allowed to see all current state events in the room, and all subsequent events associated with the room until the user leaves the room.

After a user has joined a room, the room will appear as an entry in the response of the /initialSync and /sync APIs.

post/_matrix/client/v3/join/{roomIdOrAlias}

Request

Path parameters

string mx-room-id required
OR
string mx-room-alias required

The room identifier or alias to join.

Query parameters

viastring[]

The servers to attempt to join the room through. One of the servers must be participating in the room.

Request body

reasonstring

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

Example request

{
  "reason": "Looking for support",
  "third_party_signed": {
    "mxid": "@bob:example.org",
    "sender": "@alice:example.org",
    "signatures": {
      "example.org": {
        "ed25519:0": "some9signature"
      }
    },
    "token": "random8nonce"
  }
}

Response

The room has been joined.

The joined room ID must be returned in the room_id field.

room_idstring mx-room-id required

The joined room ID.

Changes

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