View as Markdown
Element icon

Element ACTION

Unban User

Lift a ban on a user in a room, reversing Ban User. Unbanning does not put the user back in the room — it only allows them to be invited again, and to rejoin if the room's join rules would otherwise let them. The connected account must have a power level high enough to unban, otherwise the API returns M_FORBIDDEN. Use List Rooms to find the room ID. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Element account once, then configure and run Unban 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-unban-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.

Unban User inputs
Property Type Description
roomId Room ID string
The Matrix room ID to unban 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 unban, e.g. @alice:matrix.org.
Required
reason Reason string
Optional reason recorded on the unbanned user's membership event, e.g. They've been banned long enough.
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-unban-user
Version
0.0.2
App
Element
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes