View as Markdown
Elastic Email icon

Elastic Email ACTION

Unsubscribe Contact

Unsubscribes a contact from future emails. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Elastic Email account once, then configure and run Unsubscribe Contact 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: "elastic_email-unsubscribe-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    elastic_email: { authProvisionId: "apn_xxxxxxx" },
    unsubscribeEmails: ["Email Addresses"],
  },
})

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.

Unsubscribe Contact inputs
Property Type Description
unsubscribeEmails Email Addresses string[]
A list of email addresses to unsubscribe
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
elastic_email-unsubscribe-contact
Version
0.0.3
App
Elastic Email
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes