---
title: "Invite a user to participate in a particular room."
method: POST
path: "/_matrix/client/v3/rooms/{roomId}/invite"
tags: ["Room membership"]
---

# Invite a user to participate in a particular room.

`POST /_matrix/client/v3/rooms/{roomId}/invite`

## Request

- Base URL: `https://matrix.org`
- URL: `https://matrix.org/_matrix/client/v3/rooms/{roomId}/invite`
- Auth: one of:
  - API key in query parameter `access_token`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/matrix/apis/matrix-client-server-api/docs/_matrix/client/v3/rooms/:roomId/invite/post.ts> (a function with typed inputs; its response is checked against the schema)

*Note that there are two forms of this API, which are documented separately.
This version of the API does not require that the inviter know the Matrix
identifier of the invitee, and instead relies on third-party identifiers.
The homeserver uses an identity server to perform the mapping from
third-party identifier to a Matrix identifier. The other is documented in the*
[joining rooms section](https://spec.matrix.org/v1.19/client-server-api/#post_matrixclientv3roomsroomidinvite).

This API invites a user to participate in a particular room.
They do not start participating in the room until they actually join the
room.

Only users currently in a particular room can invite other users to
join that room.

If the identity server did know the Matrix user identifier for the
third-party identifier, the homeserver will append a `m.room.member`
event to the room.

If the identity server does not know a Matrix user identifier for the
passed third-party identifier, the homeserver will issue an invitation
which can be accepted upon providing proof of ownership of the third-
party identifier. This is achieved by the identity server generating a
token, which it gives to the inviting homeserver. The homeserver will
add an `m.room.third_party_invite` event into the graph for the room,
containing that token.

When the invitee binds the invited third-party identifier to a Matrix
user ID, the identity server will give the user a list of pending
invitations, each containing:

- The room ID to which they were invited

- The token given to the homeserver

- A signature of the token, signed with the identity server's private key

- The matrix user ID who invited them to the room

## Path parameters

- `roomId` string, mx-room-id, required

## Request body

- object
  - `address` string, required: The invitee's third-party identifier.
  - `id_access_token` string, required: An access token previously registered with the identity server. Servers can treat this as optional to distinguish between r0.5-compatible clients and this specification version.
  - `id_server` string, required: The hostname+port of the identity server which should be used for third-party identifier lookups.
  - `medium` string, required: The kind of address being passed in the address field, for example `email` (see [the list of recognised values](https://spec.matrix.org/v1.19/appendices/#3pid-types)).

## Response `200`

The user has been invited to join the room.

- object

## Other responses

- `403`: You do not have permission to invite the user to the room. A meaningful `errcode` and description error text will be returned. Example reasons for rejections are: - The invitee has been banned from the room. - The invitee is already a member of the room. - The inviter is not currently in the room. - The inviter's power level is insufficient to invite users to the room. **[Added in `v1.18`]** The `M_INVITE_BLOCKED` error code is used to indicate that the homeserver rejected the invite due to [invite blocking](https://spec.matrix.org/v1.19/client-server-api/#invite-permission).
- `429`: This request was rate-limited.

---

[API](https://skmtc.dev/matrix/apis/matrix-client-server-api.md) - [All operations](https://skmtc.dev/matrix/apis/matrix-client-server-api/llms.txt) - [OpenAPI document](https://skmtc.dev/matrix/apis/matrix-client-server-api/revisions/c7fe4072c681?raw)