View as Markdown
Encharge icon

Encharge ACTION

Archive Person

Archive a person in Encharge. See the documentation
  • Action
  • Writes data
  • Destructive
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Encharge account once, then configure and run Archive Person 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: "encharge-archive-person",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    encharge: { authProvisionId: "apn_xxxxxxx" },
    userId: "User ID",
    email: "Email",
  },
})

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.

Archive Person inputs
Property Type Description
userId User ID string
The user ID of the person to archive.
Optional Dynamic
email Email string
The email of the person to archive.
Optional
force Force boolean
If set to true, will delete the person's data. This is useful for GDPR-compliant removal of user data.
Required

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
encharge-archive-person
Version
0.0.1
App
Encharge
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes