View as Markdown
VBOUT icon

VBOUT ACTION

Create Email List

This action creates a new list. See the docs here
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's VBOUT account once, then configure and run Create Email List 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-create-email-list",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    vbout: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    emailSubject: "Email Subject",
  },
})

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.

Create Email List inputs
Property Type Description
name Name string
The name of the list.
Required
emailSubject Email Subject string
The default subscription subject.
Optional
replyTo Reply To string
The Reply to email of the list.
Optional
fromEmail From Email string
The From email of the list.
Optional
fromName From Name string
The From name of the list.
Optional
doubleOptin Double Optin boolean
Email confirmation required (Double opt-in)?
Optional
notify Notify string
Notify me of new subscribers.
Optional
notifyEmail Notify Email string
Notification Email.
Optional
successEmail Success Email string
Subscription Success Email.
Optional
successMessage Success Message string
Subscription Success Message.
Optional
errorMessage Error Message string
Subscription Error Message.
Optional
confirmationEmail Confirmation Email string
Confirmation Email Message.
Optional
confirmationMessage Confirmation Message string
Confirmation Message.
Optional
communications Communications boolean
Turn off Communications?
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
vbout-create-email-list
Version
0.0.2
App
VBOUT
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes