View as Markdown
Simplero icon

Simplero ACTION

Subscribe To List

Subscribe a contact to a list. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Simplero account once, then configure and run Subscribe To List 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: "simplero-subscribe-to-list",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    simplero: { 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.

Subscribe To List inputs
Property Type Description
listId List ID string
The ID of the list
Required Dynamic
email Email string
The email address of the contact to subscribe
Required
firstName First Name string
The first name of the contact
Optional
lastName Last Name string
The last name of the contact
Optional
ipAddress IP Address string
The IP address of the contact
Optional
referrer Referrer string
The referrer URL
Optional
ref Ref integer
The ref of the contact
Optional
landingPageId Landing Page ID integer
The landing page ID to track the contact from
Optional
tags Tags string[]
A list of tags to add to the contact
Optional
phone Phone string
Sanitized phone number with country code first, e.g. '15551231234'
Optional
gdprConsent GDPR Consent boolean
Whether the contact has given GDPR consent
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
simplero-subscribe-to-list
Version
0.0.1
App
Simplero
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes