View as Markdown
Sender icon

Sender ACTION

Add Subscriber To Group

Adds one or more subscribers to the specified group. 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 Add Subscriber To Group 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-add-subscriber-to-group",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    sender: { authProvisionId: "apn_xxxxxxx" },
    groupId: "Group ID",
    subscribers: ["Subscribers"],
  },
})

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.

Add Subscriber To Group inputs
Property Type Description
groupId Group ID string
The ID of the group to add subscribers to
Required Dynamic
subscribers Subscribers string[]
Array of email addresses to add to the group
Required Dynamic
triggerAutomation Trigger Automation boolean
This property by default is true. You can send it as false if you want not 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-add-subscriber-to-group
Version
0.0.1
App
Sender
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes