Mailchimp Integration
Overview
Mailchimp is a leading email marketing platform that helps businesses connect with their customers through email campaigns, automation, and audience management. The Mailchimp integration package enables seamless synchronization of audience members (contacts/subscribers) between Mailchimp and other systems in your integration workflows.
This integration uses the Mailchimp API v3 via the mailchimp-api-v3 Node.js library to provide reliable connections to your Mailchimp audiences (formerly called "lists").
Key Features
👥 Audience Management
Sync subscribers between Mailchimp and your systems for centralized contact management
📧 Contact Synchronization
Pull new audience members or push contacts from e-commerce, CRM, or custom applications
🔄 Bi-Directional Sync
Both pull and push operations to keep contact data in sync across platforms
📊 Subscriber Data
Access complete subscriber information including email, status, merge fields, and tags
⚡ API v3 Support
Built on the latest Mailchimp API version for reliability and feature coverage
🎯 List Targeting
Work with specific audiences by list ID for precise contact management
When to Use This Integration
- Pull subscribers from Mailchimp to sync with your CRM or customer database
- Add new contacts to Mailchimp from e-commerce orders or registrations
- Update subscriber information based on customer activity in your systems
- Sync unsubscribes to keep email preferences consistent across platforms
- Build custom workflows triggered by Mailchimp subscriber changes
- Maintain GDPR compliance by syncing consent and preferences
Configuration
Required Fields
Configure the Mailchimp integration with your API credentials:
{
"mailchimp": {
"api_key": "6e7aac687c132a750aab9b69a867d6e7-us14"
}
}api_key
Type: String (required)
Description: Your Mailchimp API key with datacenter suffix
Format: your_api_key-dc where dc is your datacenter (e.g., us14, us19)
Example: 6e7aac687c132a750aab9b69a867d6e7-us14
Important: The datacenter suffix (after the dash) must match your Mailchimp account datacenter
🔑 How to Get Your API Key
- Log into your Mailchimp account
- Go to Account → Extras → API keys
- Click Create A Key to generate a new API key
- Copy the full key including the datacenter suffix (e.g.,
abc123-us14) - Note: The datacenter (us14, us19, etc.) is part of your API key and determines which Mailchimp server to connect to
Audience Configuration
List ID Requirement
Most Mailchimp operations require a list_id to specify which audience to work with:
{
"mailchimp": {
"api_key": "your_api_key-us14",
"audience": {
"list_id": "a263162ad1"
}
}
}📋 How to Find Your List ID
- Log into your Mailchimp account
- Go to Audience → All contacts
- Click Settings dropdown → Audience name and defaults
- Scroll to Audience ID (found on the right side)
- Copy the alphanumeric list ID (e.g.,
a263162ad1)
Use Cases
🛍️ E-commerce Integration
Automatically add customers to Mailchimp when they complete a purchase or create an account.
📊 CRM Synchronization
Keep customer contact information synchronized between your CRM and Mailchimp audiences.
🎯 Segmentation Sync
Pull subscriber data to analyze segments or update customer profiles in external systems.
📧 Preference Management
Sync email preferences and unsubscribes across multiple platforms for compliance.
🔄 Newsletter Signup
Add subscribers from website forms, landing pages, or mobile apps to Mailchimp lists.
👥 Contact Enrichment
Update Mailchimp subscriber merge fields with data from other systems (purchase history, preferences, etc.).
API Rate Limits
Mailchimp API Limits
Mailchimp enforces rate limits to ensure service stability:
- 10 simultaneous connections per API key
- Rate limit varies by plan:
- Free plans: Lower rate limits
- Paid plans: Higher rate limits (typically 4,000-8,000 requests per hour)
- Batch operations count as a single API request but process multiple operations
💡 Best Practices for Rate Limits
- Use batch operations when adding/updating multiple subscribers
- Configure appropriate
chunk_waiting_timein Retrieve workflows - Monitor API usage in your Mailchimp account dashboard
- Consider upgrading your Mailchimp plan for higher limits if needed
- Implement error handling for 429 (Too Many Requests) responses
Data Privacy & Compliance
GDPR & CAN-SPAM Compliance
When working with Mailchimp audience data, ensure compliance with data protection regulations:
- ✅ Obtain proper consent before adding contacts to Mailchimp
- ✅ Respect unsubscribe requests and sync them across all systems
- ✅ Handle personal data securely during transfer between systems
- ✅ Maintain accurate records of consent and subscription sources
- ✅ Use double opt-in when possible for better list quality
- ✅ Implement data retention policies consistent with GDPR requirements
⚠️ Important: Email Marketing Regulations
Sending unsolicited emails or adding contacts without permission violates CAN-SPAM, GDPR, and Mailchimp's Terms of Service. Always obtain explicit consent before subscribing contacts to email lists.
Subscriber Status Types
Mailchimp Subscriber Statuses
Subscribers in Mailchimp can have different statuses:
✅ subscribed
Active subscriber who has opted in and can receive campaigns
⏸️ unsubscribed
Contact who has opted out and should not receive campaigns
🔍 cleaned
Email address was removed due to bounces or invalid address
⏳ pending
Awaiting double opt-in confirmation (if enabled)
🗃️ archived
Contact was archived and will not receive campaigns
Merge Fields
About Merge Fields
Merge fields (also called merge tags or audience fields) store additional information about subscribers beyond their email address:
- FNAME / LNAME: First and last name (default fields)
- PHONE: Phone number
- ADDRESS: Physical address
- BIRTHDAY: Date of birth
- Custom fields: Any additional data you define (purchase history, preferences, etc.)
When syncing subscribers, you can map data from your systems to Mailchimp merge fields for personalization and segmentation.
Troubleshooting
🔴 Issue: "Invalid API Key"
Cause: API key is incorrect or datacenter suffix is missing/wrong.
Solution: Verify API key includes datacenter (e.g., key-us14). Check that datacenter matches your account.
🔴 Issue: "List does not exist"
Cause: List ID is incorrect or list was deleted.
Solution: Verify list_id in Mailchimp audience settings. Ensure the list exists in your account.
🔴 Issue: "Rate limit exceeded"
Cause: Too many API requests in short time period.
Solution: Increase chunk_waiting_time in Retrieve configuration or upgrade Mailchimp plan for higher limits.
🔴 Issue: "Member already exists"
Cause: Trying to add a subscriber that's already in the audience.
Solution: Use update operations instead, or check for existence before adding. Some actions handle this automatically.
🔴 Issue: "Invalid email address"
Cause: Email format validation failed.
Solution: Validate email addresses before sending to Mailchimp. Ensure proper format (user@domain.com).
Performance Optimization
⚡ Use Batch Operations
When adding or updating multiple subscribers, use batch operations (handled automatically by Retrieve) to reduce API calls and improve performance.
🎯 Filter Strategically
When pulling audience members, use Mailchimp's built-in filters (by status, segment, etc.) rather than pulling all members and filtering client-side.
⏰ Schedule During Off-Peak
For large audience syncs, schedule during off-peak hours to stay within rate limits and minimize impact on other integrations.
Support & Resources
For help with Mailchimp integration:
- Check the Mailchimp API Documentation
- Review API Key documentation
- See Audience management guides
- Check mailchimp-api-v3 library docs
- Contact Retrieve support for integration-specific questions