Skip to main content
Mailchimp logo

Overview

Add Mailchimp to any ModuleX agent or workflow. Mailchimp marketing platform integration via the v3.0 REST API. Pure HTTP. 19 actions across lists, subscribers, campaigns, tags, notes, and segments.
Categories: Marketing & Advertising · Marketing & Email · Email Marketing · CRM · Auth: OAuth2, API Key · Actions: 19

Authentication

OAuth2 Authentication

Connect using Mailchimp OAuth2 (recommended — avoids datacenter discovery and Basic Auth headaches).

Required Credentials

OAuth Configuration

  • Authorization URL: https://login.mailchimp.com/oauth2/authorize
  • Token URL: https://login.mailchimp.com/oauth2/token

Available Actions

Parameters

integer
Results (max 1000) (Default: 10)
integer
Results to skip (Default: 0)

Response

Parameters

string
required
The unique list/audience ID

Response

Parameters

string
required
List name
string
required
Company name
string
required
Street address
string
required
City
string
required
State/province
string
required
Postal code
string
required
ISO3166 country code (e.g. ‘US’)
string
required
Permission reminder text
string
required
Default from name
string
required
Default from email
string
required
Default subject line
string
Default language (Default: en)
boolean
Allow subscribers to choose HTML or text (Default: false)

Response

Parameters

string
required
The unique list/audience ID

Response

Parameters

string
required
The unique list/audience ID
integer
Results (max 1000) (Default: 10)
integer
Results to skip (Default: 0)
string
subscribed/unsubscribed/cleaned/pending/transactional/archived

Response

Parameters

string
required
The unique list/audience ID
string
required
Subscriber email address

Response

Parameters

string
required
The unique list/audience ID
string
required
Subscriber email address
string
Status if new (default ‘subscribed’) (Default: subscribed)
string
Current status
string
‘html’ or ‘text’
object
Merge fields (e.g. {‘FNAME’: ‘John’})
string
Subscriber language
boolean
VIP status
array
Tags to add (active)

Response

Parameters

string
required
The unique list/audience ID
string
required
Subscriber email address

Response

Parameters

integer
Results (max 1000) (Default: 10)
integer
Results to skip (Default: 0)
string
regular/plaintext/absplit/rss/variate
string
save/paused/schedule/sending/sent

Response

Parameters

string
required
Campaign ID

Response

Parameters

string
Campaign type (Default: regular)
string
required
The unique list/audience ID
string
required
Subject line
string
required
From name
string
required
Reply-to email
string
Campaign title
string
Preview text

Response

Parameters

string
required
Campaign ID

Response

Parameters

string
required
Campaign ID

Response

Parameters

string
required
Campaign ID

Response

Parameters

string
required
The unique list/audience ID
string
required
Subscriber email address

Response

Parameters

string
required
The unique list/audience ID
string
required
Subscriber email address
array
required
List of {name, status} where status is ‘active’ or ‘inactive’

Response

Parameters

string
required
The unique list/audience ID
string
required
Subscriber email address
string
required
Note content

Response

Parameters

string
required
The unique list/audience ID
integer
Results (max 1000) (Default: 10)
integer
Results to skip (Default: 0)

Response

Parameters

string
required
The unique list/audience ID
string
required
Segment ID
string
required
Subscriber email address

Response

Customer.io

Klaviyo

SendGrid