# Invite User — Element

> Invite a user to an existing room. The connected account must already be joined to the room and have permission to invite. Optionally include a Reason, which is stored on the membership event. See the documentation

- Key: `element-invite-user`
- Type: Action (Write)
- Version: 0.0.2
- App: Element (`element`) — https://pipedream.com/apps/element.md
- This page (HTML): https://pipedream.com/apps/element/actions/invite-user
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/element/actions/invite-user/invite-user.mjs

## Description

Invite a user to an existing room. The connected account must already be joined to the room and have permission to invite. Optionally include a `Reason`, which is stored on the membership event. [See the documentation](https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3roomsroomidinvite)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `roomId` | `string` | Yes | The Matrix room ID, e.g. !OGEhHVWSdvArJzumhm:matrix.org. Use List Rooms to find the ID of a room you've already joined, or Resolve Room Alias to convert an alias such as #engineering:matrix.org into an ID. Aliases are not accepted here. |
| `userId` | `string` | Yes | The full Matrix ID of the user to invite, e.g. @alice:matrix.org. Note that some homeservers accept invites for user IDs that are not registered yet, so a successful response does not confirm the user exists. |
| `reason` | `string` | No | Optional reason included on the membership event sent to the invitee, e.g. Welcome to the team!. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "element",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "element-invite-user",
  arguments: {
    roomId: "Room ID",
    userId: "User ID",
  },
})
```

**TypeScript**

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "element-invite-user",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    element: { authProvisionId: "apn_xxxxxxx" },
    roomId: "Room ID",
    userId: "User ID",
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "element-invite-user",
    "configured_props": {
      "element": { "authProvisionId": "apn_xxxxxxx" },
      "roomId": "Room ID",
      "userId": "User ID"
    }
  }'
```

---

- App: https://pipedream.com/apps/element.md · All apps: https://pipedream.com/apps