View as Markdown
Unisender icon

Unisender ACTION

Unsubscribe Contact

This method unsubscribes the contact email or phone number from one or several lists. See the docs here
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Unisender 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: "unisender-unsubscribe-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    unisender: { authProvisionId: "apn_xxxxxxx" },
    contactType: "Contact Type",
    contact: "Contact",
  },
})

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
contactType Contact Type string
The type of the contact to be unsubscribed.
Required
contact Contact string
Email or phone number that needs be unsubscribed from campaigns.
Required
lists Lists string[]
Lists in which the contact will be added.
Optional 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
unisender-unsubscribe-contact
Version
0.0.4
App
Unisender
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes