View as Markdown
listmonk icon

listmonk ACTION

Create Campaign

Creates a new campaign in Listmonk. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's listmonk account once, then configure and run Create 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: "listmonk-create-campaign",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    listmonk: { authProvisionId: "apn_xxxxxxx" },
    name: "Campaign 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 Campaign inputs
Property Type Description
name Campaign Name string
The name of the campaign to create.
Required
subject Subject string
The subject of the campaign.
Required
listIds Lists string[]
Array of list IDs to subscribe to (marked as unconfirmed by default).
Required Dynamic
type Type string
The type of the campaign.
Required
contentType Content Type string
The content type of the campaign.
Required
body Body string
The body of the campaign.
Required
fromEmail From Email string
From e-mail to show on the campaign e-mails. If left empty, the default value from settings is used.
Optional
tags Tags string[]
Array of string tags to mark the campaign.
Optional
sendAt Send At string
A timestamp to schedule the campaign at. Eg: 2021-12-25T06:00:00 (YYYY-MM-DDTHH:MM:SS)
Optional
templateId Template string
ID of the template to use. If left empty, the default template is used.
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
listmonk-create-campaign
Version
0.0.2
App
listmonk
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes