View as Markdown
Sendy icon

Sendy ACTION

Add or Update a Subscriber

Adds a new subscriber or updates existing subscriber's details for a specific list. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Sendy account once, then configure and run Add or Update a 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: "sendy-add-update-subscriber",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    sendy: { authProvisionId: "apn_xxxxxxx" },
    brandId: "Brand ID",
    list: "List ID",
  },
})

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 or Update a Subscriber inputs
Property Type Description
brandId Brand ID string
The ID of the brand.
Required Dynamic
list List ID string
The ID of the list you want to subscribe a user.
Required Dynamic
email Email string
The email address of the subscriber.
Required
name Name string
The user's name.
Optional
country Country string
Optional
ipaddress IP Address string
The user's IP address.
Optional
referrer Referrer string
The URL where the user signed up from.
Optional
gdpr GDPR boolean
If you're signing up EU users in a GDPR compliant manner, set this to true.
Optional
silent silent boolean
Set to True if your list is 'Double opt-in' but you want to bypass that and signup the user to the list as 'Single Opt-in instead'
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
sendy-add-update-subscriber
Version
0.0.2
App
Sendy
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes