View as Markdown
Omnisend icon

Omnisend ACTION

Unsubscribe Contact by Email

Unsubscribe an existing Omnisend contact from the email channel by their full email address. This action does not create new contacts. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Omnisend account once, then configure and run Unsubscribe Contact by Email 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: "omnisend-unsubscribe-contact-by-email",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    omnisend: { authProvisionId: "apn_xxxxxxx" },
    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.

Unsubscribe Contact by Email inputs
Property Type Description
email Email string
The full email address of the existing contact 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
omnisend-unsubscribe-contact-by-email
Version
0.0.2
App
Omnisend
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes