View as Markdown
VBOUT icon

VBOUT ACTION

Create Email Marketing Campaign

This action creates a new email marketing campaign. 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 Marketing Campaign 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-marketing-campaign",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    vbout: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    subject: "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 Marketing Campaign inputs
Property Type Description
name Name string
Name of the campaign.
Required
subject Subject string
The subject line for the campaign.
Required
fromEmail From Email string
The From email of the campaign.
Required
fromName From Name string
The From name of the campaign.
Required
replyTo Reply To string
The Reply to email of the campaign.
Required
body Body string
Message body.
Required
type Type string
The type of the campaign.
Optional
isScheduled Is Scheduled boolean
The flag to schedule the campaign for the future.
Optional
isDraft Is Draft boolean
The flag to set the campaign to draft.
Optional
scheduledDatetime Scheduled Datetime string
The date and time to schedule the campaign. Date format accepted: m/d/Y | Y-m-d
Optional
audiences Audiences string[]
IDs of audience campaign recipients.
Required Dynamic
lists List string[]
Select the list to fetch the contacts.
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
vbout-create-email-marketing-campaign
Version
0.0.2
App
VBOUT
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes