View as Markdown
Element icon

Element ACTION

Leave Room

Leave a room the connected account has joined, or reject a pending invite to it. After leaving, the account stops receiving new events in the room; rejoining an invite-only room requires a fresh invite, so treat this as hard to undo. 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 Leave Room 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-leave-room",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    element: { authProvisionId: "apn_xxxxxxx" },
    roomId: "Room ID",
    reason: "Reason",
  },
})

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.

Leave Room inputs
Property Type Description
roomId Room ID string
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.
Required
reason Reason string
Optional reason recorded on the membership event other room members see, e.g. Saying farewell - thanks for the support!.
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-leave-room
Version
0.0.2
App
Element
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes