View as Markdown
Newsman icon

Newsman ACTION

Create Subscriber

Create a new subscriber in Newsman. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Newsman 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: "newsman-create-subscriber",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    newsman: { authProvisionId: "apn_xxxxxxx" },
    listId: "List ID",
    email: "Email",
  },
})

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
listId List ID string
The ID of a list
Required Dynamic
email Email string
The email address of the subscriber
Required
ip IP string
The IP address of the subscriber
Required
firstName First Name string
The first name of the subscriber
Optional
lastName Last Name string
The last name of the subscriber
Optional
props Props object
Hash array with props (can be later used to build segment criteria). Tags may be specified by adding the tag_ prefix to the key of a prop, eg: tag_city
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
newsman-create-subscriber
Version
0.0.1
App
Newsman
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes