View as Markdown
ReachMail icon

ReachMail ACTION

Opt Out Recipient From List

The action will remove the recipient from the specified list. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ReachMail account once, then configure and run Opt Out Recipient From List 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: "reachmail-opt-out-recipient-from-list",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    reachmail: { authProvisionId: "apn_xxxxxxx" },
    recipient: "Recipient Email",
    listId: "List 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.

Opt Out Recipient From List inputs
Property Type Description
recipient Recipient Email string
The email address of the recipient.
Required
listId List ID string
The ID of the list from which the recipient should be opted out.
Required Dynamic

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
reachmail-opt-out-recipient-from-list
Version
0.0.2
App
ReachMail
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes