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
Get Audiences (
mailchimp_get_audiences)Retrieve a list of audiences (lists) from Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Audiences data and metadata |
Get Audience
Operation
Get Audience
API Key*
••••••••
Audience ID*
Audience/List ID
Get Audience (
mailchimp_get_audience)Retrieve details of a specific audience (list) from Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Audience data and metadata |
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*
True
Create Audience (
mailchimp_create_audience)Create a new audience (list) in Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
audienceName | string | Yes | The name of the list |
contact | string | Yes | JSON object of contact information |
permissionReminder | string | Yes | Permission reminder text |
campaignDefaults | string | Yes | JSON object of default campaign settings |
emailTypeOption | string | Yes | Support multiple email formats |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Created audience 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
True
Update Audience (
mailchimp_update_audience)Update an existing audience (list) in Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
audienceName | string | No | The name of the list |
permissionReminder | string | No | Permission reminder text |
campaignDefaults | string | No | JSON object of default campaign settings |
emailTypeOption | string | No | Support multiple email formats |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Updated audience data |
Delete Audience
Operation
Delete Audience
API Key*
••••••••
Audience ID*
Audience/List ID
Delete Audience (
mailchimp_delete_audience)Delete an audience (list) from Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list to delete |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Deletion confirmation |
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
Get Members (
mailchimp_get_members)Retrieve a list of members from a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
status | string | No | Filter by status (subscribed, unsubscribed, cleaned, pending) |
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Members data and metadata |
Get Member
Operation
Get Member
API Key*
••••••••
Audience ID*
Audience/List ID
Subscriber Email*
Email address or MD5 hash
Get Member (
mailchimp_get_member)Retrieve details of a specific member from a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
subscriberEmail | string | Yes | Member email address or MD5 hash |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Member data and metadata |
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
Add Member (
mailchimp_add_member)Add a new member to a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
emailAddress | string | Yes | Member email address |
status | string | Yes | Subscriber status |
mergeFields | string | No | JSON object of merge fields |
interests | string | No | JSON object of interests |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Added member 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
Add or Update Member (
mailchimp_add_or_update_member)Add a new member or update an existing member in a Mailchimp audience (upsert)
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
subscriberEmail | string | Yes | Member email address or MD5 hash |
emailAddress | string | Yes | Member email address |
statusIfNew | string | Yes | Subscriber status if new member |
mergeFields | string | No | JSON object of merge fields |
interests | string | No | JSON object of interests |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Member 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
Update Member (
mailchimp_update_member)Update an existing member in a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
subscriberEmail | string | Yes | Member email address or MD5 hash |
emailAddress | string | No | Member email address |
status | string | No | Subscriber status |
mergeFields | string | No | JSON object of merge fields |
interests | string | No | JSON object of interests |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Updated member data |
Delete Member
Operation
Delete Member
API Key*
••••••••
Audience ID*
Audience/List ID
Subscriber Email*
Email address or MD5 hash
Delete Member (
mailchimp_delete_member)Delete a member from a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
subscriberEmail | string | Yes | Member email address or MD5 hash |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Deletion confirmation |
Archive Member
Operation
Archive Member
API Key*
••••••••
Audience ID*
Audience/List ID
Subscriber Email*
Email address or MD5 hash
Archive Member (
mailchimp_archive_member)Permanently archive (delete) a member from a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
subscriberEmail | string | Yes | Member email address or MD5 hash |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Archive confirmation |
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...
Unarchive Member (
mailchimp_unarchive_member)Restore an archived member to a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
subscriberEmail | string | Yes | Member email address or MD5 hash |
emailAddress | string | Yes | Member email address |
status | string | Yes | Subscriber status |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Unarchived member 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
Get Campaigns (
mailchimp_get_campaigns)Retrieve a list of campaigns from Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
campaignType | string | No | Filter by campaign type (regular, plaintext, absplit, rss, variate) |
status | string | No | Filter by status (save, paused, schedule, sending, sent) |
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Campaigns data and metadata |
Get Campaign
Operation
Get Campaign
API Key*
••••••••
Campaign ID*
Campaign ID
Get Campaign (
mailchimp_get_campaign)Retrieve details of a specific campaign from Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
campaignId | string | Yes | The unique ID for the campaign |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Campaign data and metadata |
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
Create Campaign (
mailchimp_create_campaign)Create a new campaign in Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
campaignType | string | Yes | Campaign type |
campaignSettings | string | Yes | JSON object of campaign settings |
recipients | string | No | JSON object of recipients |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Created campaign 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
Update Campaign (
mailchimp_update_campaign)Update an existing campaign in Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
campaignId | string | Yes | The unique ID for the campaign |
campaignSettings | string | No | JSON object of campaign settings |
recipients | string | No | JSON object of recipients |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Updated campaign data |
Delete Campaign
Operation
Delete Campaign
API Key*
••••••••
Campaign ID*
Campaign ID
Delete Campaign (
mailchimp_delete_campaign)Delete a campaign from Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
campaignId | string | Yes | The unique ID for the campaign to delete |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Deletion confirmation |
Send Campaign
Operation
Send Campaign
API Key*
••••••••
Campaign ID*
Campaign ID
Send Campaign (
mailchimp_send_campaign)Send a Mailchimp campaign
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
campaignId | string | Yes | The unique ID for the campaign to send |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Send confirmation |
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)
Schedule Campaign (
mailchimp_schedule_campaign)Schedule a Mailchimp campaign to be sent at a specific time
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
campaignId | string | Yes | The unique ID for the campaign to schedule |
scheduleTime | string | Yes | ISO 8601 format date and time |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Schedule confirmation |
Unschedule Campaign
Operation
Unschedule Campaign
API Key*
••••••••
Campaign ID*
Campaign ID
Unschedule Campaign (
mailchimp_unschedule_campaign)Unschedule a previously scheduled Mailchimp campaign
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
campaignId | string | Yes | The unique ID for the campaign to unschedule |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Unschedule confirmation |
Replicate Campaign
Operation
Replicate Campaign
API Key*
••••••••
Campaign ID*
Campaign ID
Replicate Campaign (
mailchimp_replicate_campaign)Create a copy of an existing Mailchimp campaign
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
campaignId | string | Yes | The unique ID for the campaign to replicate |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Replicated campaign data |
Get Campaign Content
Operation
Get Campaign Content
API Key*
••••••••
Campaign ID*
Campaign ID
Get Campaign Content (
mailchimp_get_campaign_content)Retrieve the HTML and plain-text content for a Mailchimp campaign
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
campaignId | string | Yes | The unique ID for the campaign |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Campaign content 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
Set Campaign Content (
mailchimp_set_campaign_content)Set the content for a Mailchimp campaign
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
campaignId | string | Yes | The unique ID for the campaign |
html | string | No | The HTML content for the campaign |
plainText | string | No | The plain-text content for the campaign |
templateId | string | No | The ID of the template to use |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Campaign content data |
Get Automations
Operation
Get Automations
API Key*
••••••••
Count
Number of results (default: 10, max: 1000)
Offset
Number of results to skip
Get Automations (
mailchimp_get_automations)Retrieve a list of automations from Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Automations data and metadata |
Get Automation
Operation
Get Automation
API Key*
••••••••
Workflow ID*
Automation workflow ID
Get Automation (
mailchimp_get_automation)Retrieve details of a specific automation from Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
workflowId | string | Yes | The unique ID for the automation workflow |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Automation data and metadata |
Start Automation
Operation
Start Automation
API Key*
••••••••
Workflow ID*
Automation workflow ID
Start Automation (
mailchimp_start_automation)Start all emails in a Mailchimp automation workflow
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
workflowId | string | Yes | The unique ID for the automation workflow |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Start confirmation |
Pause Automation
Operation
Pause Automation
API Key*
••••••••
Workflow ID*
Automation workflow ID
Pause Automation (
mailchimp_pause_automation)Pause all emails in a Mailchimp automation workflow
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
workflowId | string | Yes | The unique ID for the automation workflow |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Pause confirmation |
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
Add Subscriber to Automation (
mailchimp_add_subscriber_to_automation)Manually add a subscriber to a workflow email queue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
workflowId | string | Yes | The unique ID for the automation workflow |
workflowEmailId | string | Yes | The unique ID for the workflow email |
emailAddress | string | Yes | Email address of the subscriber |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Subscriber queue data |
Get Templates
Operation
Get Templates
API Key*
••••••••
Count
Number of results (default: 10, max: 1000)
Offset
Number of results to skip
Get Templates (
mailchimp_get_templates)Retrieve a list of templates from Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Templates data and metadata |
Get Template
Operation
Get Template
API Key*
••••••••
Template ID*
Template ID
Get Template (
mailchimp_get_template)Retrieve details of a specific template from Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
templateId | string | Yes | The unique ID for the template |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Template data and metadata |
Create Template
Operation
Create Template
API Key*
••••••••
Template Name*
Template name
Template HTML*
HTML content for the template
Create Template (
mailchimp_create_template)Create a new template in Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
templateName | string | Yes | The name of the template |
templateHtml | string | Yes | The HTML content for the template |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Created template data |
Update Template
Operation
Update Template
API Key*
••••••••
Template ID*
Template ID
Template Name
Template name
Template HTML
HTML content for the template
Update Template (
mailchimp_update_template)Update an existing template in Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
templateId | string | Yes | The unique ID for the template |
templateName | string | No | The name of the template |
templateHtml | string | No | The HTML content for the template |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Updated template data |
Delete Template
Operation
Delete Template
API Key*
••••••••
Template ID*
Template ID
Delete Template (
mailchimp_delete_template)Delete a template from Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
templateId | string | Yes | The unique ID for the template to delete |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Deletion confirmation |
Get Campaign Reports
Operation
Get Campaign Reports
API Key*
••••••••
Count
Number of results (default: 10, max: 1000)
Offset
Number of results to skip
Get Campaign Reports (
mailchimp_get_campaign_reports)Retrieve a list of campaign reports from Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Campaign reports data and metadata |
Get Campaign Report
Operation
Get Campaign Report
API Key*
••••••••
Campaign ID*
Campaign ID
Get Campaign Report (
mailchimp_get_campaign_report)Retrieve the report for a specific campaign from Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
campaignId | string | Yes | The unique ID for the campaign |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Campaign report data and metadata |
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
Get Segments (
mailchimp_get_segments)Retrieve a list of segments from a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Segments data and metadata |
Get Segment
Operation
Get Segment
API Key*
••••••••
Audience ID*
Audience/List ID
Segment ID*
Segment ID
Get Segment (
mailchimp_get_segment)Retrieve details of a specific segment from a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
segmentId | string | Yes | The unique ID for the segment |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Segment data and metadata |
Create Segment
Operation
Create Segment
API Key*
••••••••
Audience ID*
Audience/List ID
Segment Name*
Segment name
Segment Options
JSON object with conditions for segment
Create Segment (
mailchimp_create_segment)Create a new segment in a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
segmentName | string | Yes | The name of the segment |
segmentOptions | string | No | JSON object of segment options |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Created segment 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
Update Segment (
mailchimp_update_segment)Update an existing segment in a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
segmentId | string | Yes | The unique ID for the segment |
segmentName | string | No | The name of the segment |
segmentOptions | string | No | JSON object of segment options |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Updated segment data |
Delete Segment
Operation
Delete Segment
API Key*
••••••••
Audience ID*
Audience/List ID
Segment ID*
Segment ID
Delete Segment (
mailchimp_delete_segment)Delete a segment from a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
segmentId | string | Yes | The unique ID for the segment to delete |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Deletion confirmation |
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
Get Segment Members (
mailchimp_get_segment_members)Retrieve members of a specific segment from a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
segmentId | string | Yes | The unique ID for the segment |
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Segment members data and metadata |
Add Segment Member
Operation
Add Segment Member
API Key*
••••••••
Audience ID*
Audience/List ID
Email Address*
Member email address
Segment ID*
Segment ID
Add Segment Member (
mailchimp_add_segment_member)Add a member to a specific segment in a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
segmentId | string | Yes | The unique ID for the segment |
emailAddress | string | Yes | Email address of the member |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Added member 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
Remove Segment Member (
mailchimp_remove_segment_member)Remove a member from a specific segment in a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
segmentId | string | Yes | The unique ID for the segment |
subscriberEmail | string | Yes | Member email address or MD5 hash |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Removal confirmation |
Get Member Tags
Operation
Get Member Tags
API Key*
••••••••
Audience ID*
Audience/List ID
Subscriber Email*
Email address or MD5 hash
Get Member Tags (
mailchimp_get_member_tags)Retrieve tags associated with a member in a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
subscriberEmail | string | Yes | Member email address or MD5 hash |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Member tags data and metadata |
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
Add Member Tags (
mailchimp_add_member_tags)Add tags to a member in a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
subscriberEmail | string | Yes | Member email address or MD5 hash |
tags | string | Yes | JSON array of tags |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Tag addition confirmation |
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
Remove Member Tags (
mailchimp_remove_member_tags)Remove tags from a member in a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
subscriberEmail | string | Yes | Member email address or MD5 hash |
tags | string | Yes | JSON array of tags with inactive status |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Tag removal confirmation |
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
Get Merge Fields (
mailchimp_get_merge_fields)Retrieve a list of merge fields from a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Merge fields data and metadata |
Get Merge Field
Operation
Get Merge Field
API Key*
••••••••
Audience ID*
Audience/List ID
Merge Field ID*
Merge field ID
Get Merge Field (
mailchimp_get_merge_field)Retrieve details of a specific merge field from a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
mergeId | string | Yes | The unique ID for the merge field |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Merge field data and metadata |
Create Merge Field
Operation
Create Merge Field
API Key*
••••••••
Audience ID*
Audience/List ID
Merge Field Name*
Merge field name
Merge Field Type*
Select...
Create Merge Field (
mailchimp_create_merge_field)Create a new merge field in a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
mergeName | string | Yes | The name of the merge field |
mergeType | string | Yes | The type of the merge field (text, number, address, phone, date, url, imageurl, radio, dropdown, birthday, zip) |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Created merge field 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
Update Merge Field (
mailchimp_update_merge_field)Update an existing merge field in a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
mergeId | string | Yes | The unique ID for the merge field |
mergeName | string | No | The name of the merge field |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Updated merge field data |
Delete Merge Field
Operation
Delete Merge Field
API Key*
••••••••
Audience ID*
Audience/List ID
Merge Field ID*
Merge field ID
Delete Merge Field (
mailchimp_delete_merge_field)Delete a merge field from a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
mergeId | string | Yes | The unique ID for the merge field to delete |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Deletion confirmation |
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
Get Interest Categories (
mailchimp_get_interest_categories)Retrieve a list of interest categories from a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Interest categories data and metadata |
Get Interest Category
Operation
Get Interest Category
API Key*
••••••••
Audience ID*
Audience/List ID
Interest Category ID*
Interest category ID
Get Interest Category (
mailchimp_get_interest_category)Retrieve details of a specific interest category from a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
interestCategoryId | string | Yes | The unique ID for the interest category |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Interest category data and metadata |
Create Interest Category
Operation
Create Interest Category
API Key*
••••••••
Audience ID*
Audience/List ID
Interest Category Title*
Interest category title
Interest Category Type*
Select...
Create Interest Category (
mailchimp_create_interest_category)Create a new interest category in a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
interestCategoryTitle | string | Yes | The title of the interest category |
interestCategoryType | string | Yes | The type of interest category (checkboxes, dropdown, radio, hidden) |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Created interest category 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
Update Interest Category (
mailchimp_update_interest_category)Update an existing interest category in a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
interestCategoryId | string | Yes | The unique ID for the interest category |
interestCategoryTitle | string | No | The title of the interest category |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Updated interest category data |
Delete Interest Category
Operation
Delete Interest Category
API Key*
••••••••
Audience ID*
Audience/List ID
Interest Category ID*
Interest category ID
Delete Interest Category (
mailchimp_delete_interest_category)Delete an interest category from a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
interestCategoryId | string | Yes | The unique ID for the interest category to delete |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Deletion confirmation |
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
Get Interests (
mailchimp_get_interests)Retrieve a list of interests from an interest category in a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
interestCategoryId | string | Yes | The unique ID for the interest category |
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Interests data and metadata |
Get Interest
Operation
Get Interest
API Key*
••••••••
Audience ID*
Audience/List ID
Interest Category ID*
Interest category ID
Interest ID*
Interest ID
Get Interest (
mailchimp_get_interest)Retrieve details of a specific interest from an interest category in a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
interestCategoryId | string | Yes | The unique ID for the interest category |
interestId | string | Yes | The unique ID for the interest |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Interest data and metadata |
Create Interest
Operation
Create Interest
API Key*
••••••••
Audience ID*
Audience/List ID
Interest Category ID*
Interest category ID
Interest Name*
Interest name
Create Interest (
mailchimp_create_interest)Create a new interest in an interest category in a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
interestCategoryId | string | Yes | The unique ID for the interest category |
interestName | string | Yes | The name of the interest |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Created interest 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
Update Interest (
mailchimp_update_interest)Update an existing interest in an interest category in a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
interestCategoryId | string | Yes | The unique ID for the interest category |
interestId | string | Yes | The unique ID for the interest |
interestName | string | No | The name of the interest |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Updated interest data |
Delete Interest
Operation
Delete Interest
API Key*
••••••••
Audience ID*
Audience/List ID
Interest Category ID*
Interest category ID
Interest ID*
Interest ID
Delete Interest (
mailchimp_delete_interest)Delete an interest from an interest category in a Mailchimp audience
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
listId | string | Yes | The unique ID for the list |
interestCategoryId | string | Yes | The unique ID for the interest category |
interestId | string | Yes | The unique ID for the interest to delete |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Deletion confirmation |
Get Landing Pages
Operation
Get Landing Pages
API Key*
••••••••
Count
Number of results (default: 10, max: 1000)
Offset
Number of results to skip
Get Landing Pages (
mailchimp_get_landing_pages)Retrieve a list of landing pages from Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Landing pages data and metadata |
Get Landing Page
Operation
Get Landing Page
API Key*
••••••••
Landing Page ID*
Landing page ID
Get Landing Page (
mailchimp_get_landing_page)Retrieve details of a specific landing page from Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
pageId | string | Yes | The unique ID for the landing page |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Landing page data and metadata |
Create Landing Page
Operation
Create Landing Page
API Key*
••••••••
Landing Page Title
Landing page title
Landing Page Type*
Select...
Create Landing Page (
mailchimp_create_landing_page)Create a new landing page in Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
landingPageType | string | Yes | The type of landing page (signup) |
landingPageTitle | string | No | The title of the landing page |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Created landing page data |
Update Landing Page
Operation
Update Landing Page
API Key*
••••••••
Landing Page ID*
Landing page ID
Landing Page Title
Landing page title
Update Landing Page (
mailchimp_update_landing_page)Update an existing landing page in Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
pageId | string | Yes | The unique ID for the landing page |
landingPageTitle | string | No | The title of the landing page |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Updated landing page data |
Delete Landing Page
Operation
Delete Landing Page
API Key*
••••••••
Landing Page ID*
Landing page ID
Delete Landing Page (
mailchimp_delete_landing_page)Delete a landing page from Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
pageId | string | Yes | The unique ID for the landing page to delete |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Deletion confirmation |
Publish Landing Page
Operation
Publish Landing Page
API Key*
••••••••
Landing Page ID*
Landing page ID
Publish Landing Page (
mailchimp_publish_landing_page)Publish a landing page in Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
pageId | string | Yes | The unique ID for the landing page |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Publish confirmation |
Unpublish Landing Page
Operation
Unpublish Landing Page
API Key*
••••••••
Landing Page ID*
Landing page ID
Unpublish Landing Page (
mailchimp_unpublish_landing_page)Unpublish a landing page in Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
pageId | string | Yes | The unique ID for the landing page |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Unpublish confirmation |
Get Batch Operations
Operation
Get Batch Operations
API Key*
••••••••
Count
Number of results (default: 10, max: 1000)
Offset
Number of results to skip
Get Batch Operations (
mailchimp_get_batch_operations)Retrieve a list of batch operations from Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Batch operations data and metadata |
Get Batch Operation
Operation
Get Batch Operation
API Key*
••••••••
Batch ID*
Batch operation ID
Get Batch Operation (
mailchimp_get_batch_operation)Retrieve details of a specific batch operation from Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
batchId | string | Yes | The unique ID for the batch operation |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Batch operation data and metadata |
Create Batch Operation
Operation
Create Batch Operation
API Key*
••••••••
Operations*
JSON array of operations with method, path, body, etc.
Create Batch Operation (
mailchimp_create_batch_operation)Create a new batch operation in Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
operations | string | Yes | JSON array of operations |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Created batch operation data |
Delete Batch Operation
Operation
Delete Batch Operation
API Key*
••••••••
Batch ID*
Batch operation ID
Delete Batch Operation (
mailchimp_delete_batch_operation)Delete a batch operation from Mailchimp
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
batchId | string | Yes | The unique ID for the batch operation to delete |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Operation success status |
output | object | Deletion confirmation |
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