matrix-spec/data/api/client-server/inviting.yaml

# Copyright 2016 OpenMarket Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
openapi: 3.1.0
info:
  title: Matrix Client-Server Room Joining API
  version: 1.0.0
paths:
  # With an extra " " to disambiguate from the 3pid invite endpoint
  # The extra space makes it sort first for what I'm sure is a good reason.
  "/rooms/{roomId}/invite ":
    post:
      summary: Invite a user to participate in a particular room.
      description: |-
        *Note that there are two forms of this API, which are documented separately.
        This version of the API requires that the inviter knows the Matrix
        identifier of the invitee. The other is documented in the
        [third-party invites](/client-server-api/#third-party-invites) section.*

        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 user was invited to the room, the homeserver will append a
        `m.room.member` event to the room.        
      operationId: inviteUser
      security:
        - accessTokenQuery: []
        - accessTokenBearer: []
      parameters:
        - in: path
          name: roomId
          description: The room identifier (not alias) to which to invite the user.
          required: true
          example: "!d41d8cd:matrix.org"
          schema:
            type: string
            format: mx-room-id
            pattern: "^!"
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example: {
                "user_id": "@cheeky_monkey:matrix.org",
                "reason": "Welcome to the team!"
              }
              properties:
                user_id:
                  type: string
                  description: The fully qualified user ID of the invitee.
                  format: mx-user-id
                  pattern: "^@"
                reason:
                  x-addedInMatrixVersion: "1.1"
                  type: string
                  description: |-
                    Optional reason to be included as the `reason` on the subsequent
                    membership event.                    
              required:
                - user_id
        required: true
      responses:
        "200":
          description: The user has been invited to join the room, or was already invited
            to the room.
          content:
            application/json:
              schema:
                type: object
              examples:
                response:
                  value: {}
        "400":
          description: |-

            The request is invalid. A meaningful `errcode` and description
            error text will be returned. Example reasons for rejection include:

            - The request body is malformed (`errcode` set to `M_BAD_JSON`
              or `M_NOT_JSON`).

            - One or more users being invited to the room are residents of a
              homeserver which does not support the requested room version. The
              `errcode` will be `M_UNSUPPORTED_ROOM_VERSION` in these cases.
          content:
            application/json:
              schema:
                $ref: definitions/errors/error.yaml
        "403":
          description: |-
            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 v="1.18"%}} The `M_INVITE_BLOCKED` error code is used to
            indicate that the homeserver rejected the invite due to
            [invite blocking](/client-server-api/#invite-permission).            
          content:
            application/json:
              schema:
                $ref: definitions/errors/error.yaml
              examples:
                response:
                  value: {
                    "errcode": "M_FORBIDDEN",
                    "error": "@cheeky_monkey:matrix.org is banned from the room"
                  }
        "429":
          description: This request was rate-limited.
          content:
            application/json:
              schema:
                $ref: definitions/errors/rate_limited.yaml
      tags:
        - Room membership
servers:
  - url: "{protocol}://{hostname}{basePath}"
    variables:
      protocol:
        enum:
          - http
          - https
        default: https
      hostname:
        default: localhost:8008
      basePath:
        default: /_matrix/client/v3
components:
  securitySchemes:
    accessTokenQuery:
      $ref: definitions/security.yaml#/accessTokenQuery
    accessTokenBearer:
      $ref: definitions/security.yaml#/accessTokenBearer