View as Markdown
listmonk icon

listmonk ACTION

Create Subscriber

Create a new subscriber 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 Subscriber 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-subscriber",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    listmonk: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    name: "Name",
  },
})

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 Subscriber inputs
Property Type Description
email Email string
The email of the subscriber to create.
Required
name Name string
The name of the subscriber to create.
Required
status Status string
The status of the new subscriber.
Required
listIds Lists string[]
Array of list IDs to subscribe to (marked as unconfirmed by default).
Optional Dynamic
preconfirmSubscription Preconfirm Subscription boolean
If true, marks subscription as confirmed and no-optin e-mails are sent for double opt-in lists.
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
listmonk-create-subscriber
Version
0.0.2
App
listmonk
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes