Mailchimp
Manage audiences, campaigns, and marketing automation in Mailchimp
Configuration
Get Audiences
Operation
Get Audiences
API Key*
••••••••
Count
Number of results (default: 10, max: 1000)
Offset
Number of results to skip
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Audience
Operation
Get Audience
API Key*
••••••••
Audience ID
Audience/List ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Create Audience
Operation
Create Audience
API Key*
••••••••
Audience Name
Name for the audience
Contact Information
JSON object with company, address1, city, state, zip, country
Permission Reminder
Permission reminder text
Campaign Defaults
JSON object with from_name, from_email, subject, language
Email Type Option
Select...
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Update Audience
Operation
Update Audience
API Key*
••••••••
Audience ID
Audience/List ID
Audience Name
Name for the audience
Contact Information
JSON object with company, address1, city, state, zip, country
Permission Reminder
Permission reminder text
Campaign Defaults
JSON object with from_name, from_email, subject, language
Email Type Option
Select...
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Delete Audience
Operation
Delete Audience
API Key*
••••••••
Audience ID
Audience/List ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Members
Operation
Get Members
API Key*
••••••••
Audience ID
Audience/List ID
Status
Select...
Count
Number of results (default: 10, max: 1000)
Offset
Number of results to skip
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Member
Operation
Get Member
API Key*
••••••••
Audience ID
Audience/List ID
Subscriber Email
Email address or MD5 hash
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Add Member
Operation
Add Member
API Key*
••••••••
Audience ID
Audience/List ID
Email Address
Member email address
Status
Select...
Merge Fields
JSON object with merge field values (e.g., {"FNAME": "John", "LNAME": "Doe"})
Interests
JSON object with interest IDs and boolean values
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Add or Update Member
Operation
Add or Update Member
API Key*
••••••••
Audience ID
Audience/List ID
Subscriber Email
Email address or MD5 hash
Email Address
Member email address
Status If New
Select...
Merge Fields
JSON object with merge field values (e.g., {"FNAME": "John", "LNAME": "Doe"})
Interests
JSON object with interest IDs and boolean values
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Update Member
Operation
Update Member
API Key*
••••••••
Audience ID
Audience/List ID
Subscriber Email
Email address or MD5 hash
Email Address
Member email address
Status
Select...
Merge Fields
JSON object with merge field values (e.g., {"FNAME": "John", "LNAME": "Doe"})
Interests
JSON object with interest IDs and boolean values
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Delete Member
Operation
Delete Member
API Key*
••••••••
Audience ID
Audience/List ID
Subscriber Email
Email address or MD5 hash
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Archive Member
Operation
Archive Member
API Key*
••••••••
Audience ID
Audience/List ID
Subscriber Email
Email address or MD5 hash
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Unarchive Member
Operation
Unarchive Member
API Key*
••••••••
Audience ID
Audience/List ID
Subscriber Email
Email address or MD5 hash
Email Address
Member email address
Status
Select...
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Campaigns
Operation
Get Campaigns
API Key*
••••••••
Campaign Type
Select...
Count
Number of results (default: 10, max: 1000)
Offset
Number of results to skip
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Campaign
Operation
Get Campaign
API Key*
••••••••
Campaign ID
Campaign ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Create Campaign
Operation
Create Campaign
API Key*
••••••••
Campaign Type
Select...
Campaign Settings
JSON object with subject_line, from_name, reply_to, etc. (required for create)
Recipients
JSON object with list_id and optional segment_opts
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Update Campaign
Operation
Update Campaign
API Key*
••••••••
Campaign ID
Campaign ID
Campaign Settings
JSON object with subject_line, from_name, reply_to, etc. (required for create)
Recipients
JSON object with list_id and optional segment_opts
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Delete Campaign
Operation
Delete Campaign
API Key*
••••••••
Campaign ID
Campaign ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Send Campaign
Operation
Send Campaign
API Key*
••••••••
Campaign ID
Campaign ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Schedule Campaign
Operation
Schedule Campaign
API Key*
••••••••
Campaign ID
Campaign ID
Schedule Time
YYYY-MM-DDTHH:mm:ssZ (e.g., 2024-12-31T10:00:00Z)
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Unschedule Campaign
Operation
Unschedule Campaign
API Key*
••••••••
Campaign ID
Campaign ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Replicate Campaign
Operation
Replicate Campaign
API Key*
••••••••
Campaign ID
Campaign ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Campaign Content
Operation
Get Campaign Content
API Key*
••••••••
Campaign ID
Campaign ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Set Campaign Content
Operation
Set Campaign Content
API Key*
••••••••
Campaign ID
Campaign ID
HTML Content
HTML content for the campaign
Plain Text Content
Plain text content for the campaign
Template ID
Template ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Automations
Operation
Get Automations
API Key*
••••••••
Count
Number of results (default: 10, max: 1000)
Offset
Number of results to skip
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Automation
Operation
Get Automation
API Key*
••••••••
Workflow ID
Automation workflow ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Start Automation
Operation
Start Automation
API Key*
••••••••
Workflow ID
Automation workflow ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Pause Automation
Operation
Pause Automation
API Key*
••••••••
Workflow ID
Automation workflow ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Add Subscriber to Automation
Operation
Add Subscriber to Automation
API Key*
••••••••
Email Address
Member email address
Workflow ID
Automation workflow ID
Workflow Email ID
Workflow email ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Templates
Operation
Get Templates
API Key*
••••••••
Count
Number of results (default: 10, max: 1000)
Offset
Number of results to skip
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Template
Operation
Get Template
API Key*
••••••••
Template ID
Template ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Create Template
Operation
Create Template
API Key*
••••••••
Template Name
Template name
Template HTML
HTML content for the template
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Update Template
Operation
Update Template
API Key*
••••••••
Template ID
Template ID
Template Name
Template name
Template HTML
HTML content for the template
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Delete Template
Operation
Delete Template
API Key*
••••••••
Template ID
Template ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Campaign Reports
Operation
Get Campaign Reports
API Key*
••••••••
Count
Number of results (default: 10, max: 1000)
Offset
Number of results to skip
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Campaign Report
Operation
Get Campaign Report
API Key*
••••••••
Campaign ID
Campaign ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Segments
Operation
Get Segments
API Key*
••••••••
Audience ID
Audience/List ID
Count
Number of results (default: 10, max: 1000)
Offset
Number of results to skip
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Segment
Operation
Get Segment
API Key*
••••••••
Audience ID
Audience/List ID
Segment ID
Segment ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Create Segment
Operation
Create Segment
API Key*
••••••••
Audience ID
Audience/List ID
Segment Name
Segment name
Segment Options
JSON object with conditions for segment
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Update Segment
Operation
Update Segment
API Key*
••••••••
Audience ID
Audience/List ID
Segment ID
Segment ID
Segment Name
Segment name
Segment Options
JSON object with conditions for segment
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Delete Segment
Operation
Delete Segment
API Key*
••••••••
Audience ID
Audience/List ID
Segment ID
Segment ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Segment Members
Operation
Get Segment Members
API Key*
••••••••
Audience ID
Audience/List ID
Segment ID
Segment ID
Count
Number of results (default: 10, max: 1000)
Offset
Number of results to skip
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Add Segment Member
Operation
Add Segment Member
API Key*
••••••••
Audience ID
Audience/List ID
Email Address
Member email address
Segment ID
Segment ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Remove Segment Member
Operation
Remove Segment Member
API Key*
••••••••
Audience ID
Audience/List ID
Subscriber Email
Email address or MD5 hash
Segment ID
Segment ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Member Tags
Operation
Get Member Tags
API Key*
••••••••
Audience ID
Audience/List ID
Subscriber Email
Email address or MD5 hash
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Add Member Tags
Operation
Add Member Tags
API Key*
••••••••
Audience ID
Audience/List ID
Subscriber Email
Email address or MD5 hash
Tags
JSON array of tag objects with name and status
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Remove Member Tags
Operation
Remove Member Tags
API Key*
••••••••
Audience ID
Audience/List ID
Subscriber Email
Email address or MD5 hash
Tags
JSON array of tag objects with name and status
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Merge Fields
Operation
Get Merge Fields
API Key*
••••••••
Audience ID
Audience/List ID
Count
Number of results (default: 10, max: 1000)
Offset
Number of results to skip
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Merge Field
Operation
Get Merge Field
API Key*
••••••••
Audience ID
Audience/List ID
Merge Field ID
Merge field ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Create Merge Field
Operation
Create Merge Field
API Key*
••••••••
Audience ID
Audience/List ID
Merge Field Name
Merge field name
Merge Field Type
Select...
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Update Merge Field
Operation
Update Merge Field
API Key*
••••••••
Audience ID
Audience/List ID
Merge Field ID
Merge field ID
Merge Field Name
Merge field name
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Delete Merge Field
Operation
Delete Merge Field
API Key*
••••••••
Audience ID
Audience/List ID
Merge Field ID
Merge field ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Interest Categories
Operation
Get Interest Categories
API Key*
••••••••
Audience ID
Audience/List ID
Count
Number of results (default: 10, max: 1000)
Offset
Number of results to skip
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Interest Category
Operation
Get Interest Category
API Key*
••••••••
Audience ID
Audience/List ID
Interest Category ID
Interest category ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Create Interest Category
Operation
Create Interest Category
API Key*
••••••••
Audience ID
Audience/List ID
Interest Category Title
Interest category title
Interest Category Type
Select...
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Update Interest Category
Operation
Update Interest Category
API Key*
••••••••
Audience ID
Audience/List ID
Interest Category ID
Interest category ID
Interest Category Title
Interest category title
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Delete Interest Category
Operation
Delete Interest Category
API Key*
••••••••
Audience ID
Audience/List ID
Interest Category ID
Interest category ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Interests
Operation
Get Interests
API Key*
••••••••
Audience ID
Audience/List ID
Interest Category ID
Interest category ID
Count
Number of results (default: 10, max: 1000)
Offset
Number of results to skip
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Interest
Operation
Get Interest
API Key*
••••••••
Audience ID
Audience/List ID
Interest Category ID
Interest category ID
Interest ID
Interest ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Create Interest
Operation
Create Interest
API Key*
••••••••
Audience ID
Audience/List ID
Interest Category ID
Interest category ID
Interest Name
Interest name
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Update Interest
Operation
Update Interest
API Key*
••••••••
Audience ID
Audience/List ID
Interest Category ID
Interest category ID
Interest ID
Interest ID
Interest Name
Interest name
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Delete Interest
Operation
Delete Interest
API Key*
••••••••
Audience ID
Audience/List ID
Interest Category ID
Interest category ID
Interest ID
Interest ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Landing Pages
Operation
Get Landing Pages
API Key*
••••••••
Count
Number of results (default: 10, max: 1000)
Offset
Number of results to skip
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Landing Page
Operation
Get Landing Page
API Key*
••••••••
Landing Page ID
Landing page ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Create Landing Page
Operation
Create Landing Page
API Key*
••••••••
Landing Page Title
Landing page title
Landing Page Type
Select...
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Update Landing Page
Operation
Update Landing Page
API Key*
••••••••
Landing Page ID
Landing page ID
Landing Page Title
Landing page title
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Delete Landing Page
Operation
Delete Landing Page
API Key*
••••••••
Landing Page ID
Landing page ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Publish Landing Page
Operation
Publish Landing Page
API Key*
••••••••
Landing Page ID
Landing page ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Unpublish Landing Page
Operation
Unpublish Landing Page
API Key*
••••••••
Landing Page ID
Landing page ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Batch Operations
Operation
Get Batch Operations
API Key*
••••••••
Count
Number of results (default: 10, max: 1000)
Offset
Number of results to skip
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Get Batch Operation
Operation
Get Batch Operation
API Key*
••••••••
Batch ID
Batch operation ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Create Batch Operation
Operation
Create Batch Operation
API Key*
••••••••
Operations
JSON array of operations with method, path, body, etc.
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Delete Batch Operation
Operation
Delete Batch Operation
API Key*
••••••••
Batch ID
Batch operation ID
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | json | Operation result data |
Usage Instructions
Integrate Mailchimp into the workflow. Can manage audiences (lists), list members, campaigns, automation workflows, templates, reports, segments, tags, merge fields, interest categories, landing pages, signup forms, and batch operations.
Notes
- Category:
tools - Type:
mailchimp