View as Markdown
VBOUT icon

VBOUT ACTION

Unsubscribe Contact

This action unsubscribes a specific contact from a list. See the docs here
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's VBOUT 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: "vbout-unsubscribe-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    vbout: { authProvisionId: "apn_xxxxxxx" },
    list: "List",
    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
list List string
Select the list to fetch the contacts.
Required Dynamic
contact Contact string
Select the contact that will be unsubscribed.
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
vbout-unsubscribe-contact
Version
0.0.2
App
VBOUT
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes