View as Markdown
Sender icon

Sender ACTION

Create Subscriber

Creates a new subscriber. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Sender 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: "sender-create-subscriber",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    sender: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    firstname: "First 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
Email address of the subscriber
Required
firstname First Name string
First name of the subscriber
Optional
lastname Last Name string
Last name of the subscriber
Optional
groupIds Group IDs string[]
The IDs of the groups
Optional Dynamic
phone Phone string
Phone number of the subscriber. Must include the country code: +370 or 00370 follow by a valid phone number
Optional
triggerAutomation Trigger Automation boolean
This property is true by default. You can send it as false if you do not want to activate an automation
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
sender-create-subscriber
Version
0.0.1
App
Sender
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes