View as Markdown
Mailchimp icon

Mailchimp ACTION

Add or Update Subscriber

Adds a new subscriber to an audience or updates existing subscriber. See docs here
  • Action
  • Writes data
  • Destructive
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

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

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 Subscriber inputs
Property Type Description
listId List Id string
The unique ID of the list
Required Dynamic
subscriberHash Subscriber string
The MD5 hash of the lowercase version of the list member's email address.
Required Dynamic
emailAddress Email address string
Email address for a subscriber.
Required
skipMergeValidation Skip merge validation boolean
If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to False.
Optional
statusIfNew Status if new string
Subscriber's status. This value is required only if the email address is not already present on the list.
Required
emailType Email type string
Type of email this member asked to get ('html' or 'text').
Optional
status Status string
Subscriber's current status.
Optional
mergeFields Merge fields object
An individual merge var and value for a member.
Optional
interests Interests object
The key of this object's properties is the ID of the interest in question.
Optional
language Language string
If set/detected, the subscriber's language.
Optional
vip Vip boolean
VIP status for subscriber.
Optional
latitude Latitude string
The location latitude.
Optional
longitude Longitude string
The location longitude.
Optional
marketingPermissionId Marketing permission ID string
The ID for the marketing permission on the list.
Optional
marketingPermissionsEnabled Marketing permissions enabled boolean
If the subscriber has opted-in to the marketing permission.
Optional
ipSignup IP signup string
IP address the subscriber signed up from.
Optional
timestampSignup Timestamp signup string
The date and time the subscriber signed up for the list in ISO 8601 format.
Optional
ipOpt IP opt in string
The IP address the subscriber used to confirm their opt-in status.
Optional
timestampOpt Timestamp opt in string
The date and time the subscriber confirmed their opt-in status in ISO 8601 format.
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
mailchimp-add-or-update-subscriber
Version
0.2.5
App
Mailchimp
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes