View as Markdown
Element icon

Element ACTION

Ban User

Ban a user from a room, also kicking them if they are currently joined. A banned user cannot rejoin or be invited back until the ban is lifted with Unban User — use Kick User instead to remove someone without blocking their return. The connected account must be in the room with a power level high enough to ban, otherwise the API returns M_FORBIDDEN. Use List Rooms to find the room ID. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Element account once, then configure and run Ban User from your backend or agent.

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-ban-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)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Ban User inputs
Property Type Description
roomId Room ID string
The Matrix room ID to ban the user from, e.g. !OGEhHVWSdvArJzumhm:matrix.org. Must be an ID, not a room alias — use Resolve Room Alias to convert one. Use List Rooms to find the ID of a room you've already joined.
Required
userId User ID string
The full Matrix ID of the user to ban, e.g. @alice:matrix.org.
Required
reason Reason string
Optional reason recorded on the banned user's membership event, e.g. Telling unfunny jokes.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
element-ban-user
Version
0.0.2
App
Element
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes