View as Markdown
Campayn icon

Campayn ACTION

Unsubscribe Contact

Unsubscribes a contact from a list. See the docs
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Campayn 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: "campayn-unsubscribe-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    campayn: { authProvisionId: "apn_xxxxxxx" },
    listId: "List",
    contactId: "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
listId List string
Identifier of a list
Required Dynamic
contactId Contact string
Identifier of a contact
Optional Dynamic
email Email string
Email address of the contact to unsubscribe
Optional

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
campayn-unsubscribe-contact
Version
0.0.2
App
Campayn
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes