View as Markdown
Mailchimp icon

Mailchimp ACTION

Update List

Updates an existing list. 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 Update 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: "mailchimp-update-list",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mailchimp: { authProvisionId: "apn_xxxxxxx" },
    listId: "List Id",
    name: "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.

Update List inputs
Property Type Description
listId List Id string
The unique ID of the list
Required Dynamic
name Name string
The name of the list.
Required
contactCompany Contact company string
The company name for the list.
Required
contactAddress1 Contact address1 string
The street address for the list contact.
Required
contactCity Contact city string
The city for the list contact.
Required
contactState Contact state string
The state for the list contact.
Required
contactCountry Contact country string
A two-character ISO3166 country code. Defaults to US if invalid.
Required
contactPhone Contact phone string
The phone number for the list contact.
Optional
contactZip Contact zip code string
The postal or zip code for the list contact.
Optional
permissionReminder Permission reminder string
The permission reminder for the list.
Required
campaignDefaultsFromName From name string
The default from name for campaigns sent to this list.
Required
campaignDefaultsFromEmail From email string
The default from email for campaigns sent to this list.
Required
campaignDefaultsSubject Subject string
The default subject line for campaigns sent to this list.
Required
campaignDefaultsLanguage Language string
The default language for this lists's forms.
Required
emailTypeOption Email type option boolean
Whether the list supports multiple formats for emails.
Required

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-update-list
Version
0.0.3
App
Mailchimp
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes