View as Markdown
Smoove icon

Smoove ACTION

Unsubscribe

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

IMPLEMENTATION

Call this tool

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

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 inputs
Property Type Description
email Email string
Email of the subscriber.
Required Dynamic
reason Reason string
Why do you want this 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
smoove-unsubscribe-contact
Version
0.0.2
App
Smoove
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes