Sim

Mailchimp

Manage audiences, campaigns, and marketing automation in Mailchimp

Mailchimp is a powerful marketing automation platform that enables you to manage audiences, campaigns, and a wide range of marketing activities all in one place. Mailchimp’s robust API and integrations let you automate outreach, email marketing, reporting, and audience management directly from your workflows in Sim.

With the Mailchimp tools in Sim, you can:

  • Manage Audiences (Lists):

    • List and retrieve all your Mailchimp audiences (lists) for easy management.
    • Get comprehensive information about a specific audience.
    • Create new audiences and keep your segmentation up-to-date.
  • List Members:

    • Access and manage list members (subscribers), retrieve member details, and keep your email lists synchronized.
  • Campaign Management:

    • Automate campaign creation, send campaigns, and analyze campaign performance with comprehensive reporting.
  • Marketing Automation:

    • Manage automated workflows, set up triggers, and schedule emails to streamline your nurture processes.
  • Templates, Segments, and Tags:

    • Retrieve and manage your email templates for consistent branding.
    • Access and update audience segments to target specific groups.
    • Create and manage tags to further organize your contacts.
  • Advanced List Controls:

    • Manage merge fields and interest categories (groups) to collect rich, structured data from your subscribers.
    • Handle landing pages, signup forms, and other lead-capture tools to maximize conversions.
  • Batch Operations and Reporting:

    • Run batch jobs for bulk operations and streamline large updates.
    • Retrieve detailed reports on campaigns, automations, and audience growth to inform your marketing strategy.

By using Mailchimp within Sim, your agents and workflows can automate email marketing at scale—growing your audience, personalizing outreach, optimizing engagement, and making data-driven decisions. Whether you’re syncing CRM records, triggering campaigns in response to in-product actions, or managing subscriber data, Mailchimp’s tools in Sim deliver complete programmatic control over your marketing automation.

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.

Tools

mailchimp_get_audiences

Retrieve a list of audiences (lists) from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
countstringNoNumber of results (default: 10, max: 1000)
offsetstringNoNumber of results to skip

Output

ParameterTypeDescription
successbooleanWhether the audiences were successfully retrieved
outputobjectAudiences data
listsjsonArray of audience/list objects
total_itemsnumberTotal number of lists
total_returnednumberNumber of lists returned in this response

mailchimp_get_audience

Retrieve details of a specific audience (list) from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list

Output

ParameterTypeDescription
successbooleanWhether the audience was successfully retrieved
outputobjectAudience data
listjsonAudience/list object
list_idstringThe unique ID of the audience

mailchimp_create_audience

Create a new audience (list) in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
audienceNamestringYesThe name of the list
contactstringYesJSON object of contact information
permissionReminderstringYesPermission reminder text
campaignDefaultsstringYesJSON object of default campaign settings
emailTypeOptionstringYesSupport multiple email formats

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectCreated audience data
listjsonCreated audience/list object
list_idstringCreated audience/list ID
successbooleanOperation success

mailchimp_update_audience

Update an existing audience (list) in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
audienceNamestringNoThe name of the list
permissionReminderstringNoPermission reminder text
campaignDefaultsstringNoJSON object of default campaign settings
emailTypeOptionstringNoSupport multiple email formats

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectUpdated audience data
listobjectUpdated audience/list object
list_idstringList ID
successbooleanOperation success

mailchimp_delete_audience

Delete an audience (list) from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list to delete

Output

ParameterTypeDescription
successbooleanWhether the audience was successfully deleted

mailchimp_get_members

Retrieve a list of members from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
statusstringNoFilter by status (subscribed, unsubscribed, cleaned, pending)
countstringNoNumber of results (default: 10, max: 1000)
offsetstringNoNumber of results to skip

Output

ParameterTypeDescription
successbooleanWhether the members were successfully retrieved
outputobjectMembers data
membersjsonArray of member objects
total_itemsnumberTotal number of members
total_returnednumberNumber of members returned in this response

mailchimp_get_member

Retrieve details of a specific member from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
subscriberEmailstringYesMember email address or MD5 hash

Output

ParameterTypeDescription
successbooleanWhether the member was successfully retrieved
outputobjectMember data
memberjsonMember object
subscriber_hashstringThe MD5 hash of the member email address

mailchimp_add_member

Add a new member to a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
emailAddressstringYesMember email address
statusstringYesSubscriber status
mergeFieldsstringNoJSON object of merge fields
interestsstringNoJSON object of interests

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectAdded member data
memberjsonAdded member object
subscriber_hashstringSubscriber hash ID
successbooleanOperation success

mailchimp_add_or_update_member

Add a new member or update an existing member in a Mailchimp audience (upsert)

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
subscriberEmailstringYesMember email address or MD5 hash
emailAddressstringYesMember email address
statusIfNewstringYesSubscriber status if new member
mergeFieldsstringNoJSON object of merge fields
interestsstringNoJSON object of interests

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectMember data
memberjsonMember object
subscriber_hashstringSubscriber hash ID
successbooleanOperation success

mailchimp_update_member

Update an existing member in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
subscriberEmailstringYesMember email address or MD5 hash
emailAddressstringNoMember email address
statusstringNoSubscriber status
mergeFieldsstringNoJSON object of merge fields
interestsstringNoJSON object of interests

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectUpdated member data
memberobjectUpdated member object
subscriber_hashstringSubscriber hash
successbooleanOperation success

mailchimp_delete_member

Delete a member from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
subscriberEmailstringYesMember email address or MD5 hash

Output

ParameterTypeDescription
successbooleanWhether the member was successfully deleted

mailchimp_archive_member

Permanently archive (delete) a member from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
subscriberEmailstringYesMember email address or MD5 hash

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectArchive confirmation
successbooleanOperation success

mailchimp_unarchive_member

Restore an archived member to a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
subscriberEmailstringYesMember email address or MD5 hash
emailAddressstringYesMember email address
statusstringYesSubscriber status

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectUnarchived member data
memberobjectUnarchived member object
subscriber_hashstringSubscriber hash
successbooleanOperation success

mailchimp_get_campaigns

Retrieve a list of campaigns from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignTypestringNoFilter by campaign type (regular, plaintext, absplit, rss, variate)
statusstringNoFilter by status (save, paused, schedule, sending, sent)
countstringNoNumber of results (default: 10, max: 1000)
offsetstringNoNumber of results to skip

Output

ParameterTypeDescription
successbooleanWhether the campaigns were successfully retrieved
outputobjectCampaigns data
campaignsjsonArray of campaign objects
total_itemsnumberTotal number of campaigns
total_returnednumberNumber of campaigns returned in this response

mailchimp_get_campaign

Retrieve details of a specific campaign from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignIdstringYesThe unique ID for the campaign

Output

ParameterTypeDescription
successbooleanWhether the campaign was successfully retrieved
outputobjectCampaign data
campaignjsonCampaign object
campaign_idstringThe unique ID of the campaign

mailchimp_create_campaign

Create a new campaign in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignTypestringYesCampaign type
campaignSettingsstringYesJSON object of campaign settings
recipientsstringNoJSON object of recipients

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectCreated campaign data
campaignjsonCreated campaign object
campaign_idstringCreated campaign ID
successbooleanOperation success

mailchimp_update_campaign

Update an existing campaign in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignIdstringYesThe unique ID for the campaign
campaignSettingsstringNoJSON object of campaign settings
recipientsstringNoJSON object of recipients

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectUpdated campaign data
campaignobjectUpdated campaign object
campaign_idstringCampaign ID
successbooleanOperation success

mailchimp_delete_campaign

Delete a campaign from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignIdstringYesThe unique ID for the campaign to delete

Output

ParameterTypeDescription
successbooleanWhether the campaign was successfully deleted

mailchimp_send_campaign

Send a Mailchimp campaign

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignIdstringYesThe unique ID for the campaign to send

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectSend confirmation
successbooleanOperation success

mailchimp_schedule_campaign

Schedule a Mailchimp campaign to be sent at a specific time

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignIdstringYesThe unique ID for the campaign to schedule
scheduleTimestringYesISO 8601 format date and time

Output

ParameterTypeDescription
successbooleanWhether the campaign was successfully scheduled

mailchimp_unschedule_campaign

Unschedule a previously scheduled Mailchimp campaign

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignIdstringYesThe unique ID for the campaign to unschedule

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectUnschedule confirmation
successbooleanOperation success

mailchimp_replicate_campaign

Create a copy of an existing Mailchimp campaign

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignIdstringYesThe unique ID for the campaign to replicate

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectReplicated campaign data
campaignobjectReplicated campaign object
campaign_idstringCampaign ID
successbooleanOperation success

mailchimp_get_campaign_content

Retrieve the HTML and plain-text content for a Mailchimp campaign

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignIdstringYesThe unique ID for the campaign

Output

ParameterTypeDescription
successbooleanWhether the campaign content was successfully retrieved
outputobjectCampaign content data
contentjsonCampaign content object

mailchimp_set_campaign_content

Set the content for a Mailchimp campaign

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignIdstringYesThe unique ID for the campaign
htmlstringNoThe HTML content for the campaign
plainTextstringNoThe plain-text content for the campaign
templateIdstringNoThe ID of the template to use

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectCampaign content data
contentobjectCampaign content object
successbooleanOperation success

mailchimp_get_automations

Retrieve a list of automations from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
countstringNoNumber of results (default: 10, max: 1000)
offsetstringNoNumber of results to skip

Output

ParameterTypeDescription
successbooleanWhether the automations were successfully retrieved
outputobjectAutomations data
automationsjsonArray of automation objects
total_itemsnumberTotal number of automations
total_returnednumberNumber of automations returned in this response

mailchimp_get_automation

Retrieve details of a specific automation from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
workflowIdstringYesThe unique ID for the automation workflow

Output

ParameterTypeDescription
successbooleanWhether the automation was successfully retrieved
outputobjectAutomation data
automationjsonAutomation object
workflow_idstringThe unique ID of the automation workflow

mailchimp_start_automation

Start all emails in a Mailchimp automation workflow

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
workflowIdstringYesThe unique ID for the automation workflow

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectStart confirmation
successbooleanOperation success

mailchimp_pause_automation

Pause all emails in a Mailchimp automation workflow

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
workflowIdstringYesThe unique ID for the automation workflow

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectPause confirmation
successbooleanOperation success

mailchimp_add_subscriber_to_automation

Manually add a subscriber to a workflow email queue

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
workflowIdstringYesThe unique ID for the automation workflow
workflowEmailIdstringYesThe unique ID for the workflow email
emailAddressstringYesEmail address of the subscriber

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectSubscriber queue data
subscriberjsonSubscriber object
successbooleanOperation success

mailchimp_get_templates

Retrieve a list of templates from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
countstringNoNumber of results (default: 10, max: 1000)
offsetstringNoNumber of results to skip

Output

ParameterTypeDescription
successbooleanWhether the templates were successfully retrieved
outputobjectTemplates data
templatesjsonArray of template objects
total_itemsnumberTotal number of templates
total_returnednumberNumber of templates returned in this response

mailchimp_get_template

Retrieve details of a specific template from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
templateIdstringYesThe unique ID for the template

Output

ParameterTypeDescription
successbooleanWhether the template was successfully retrieved
outputobjectTemplate data
templatejsonTemplate object
template_idstringThe unique ID of the template

mailchimp_create_template

Create a new template in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
templateNamestringYesThe name of the template
templateHtmlstringYesThe HTML content for the template

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectCreated template data
templatejsonCreated template object
template_idstringCreated template ID
successbooleanOperation success

mailchimp_update_template

Update an existing template in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
templateIdstringYesThe unique ID for the template
templateNamestringNoThe name of the template
templateHtmlstringNoThe HTML content for the template

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectUpdated template data
templateobjectUpdated template object
template_idstringTemplate ID
successbooleanOperation success

mailchimp_delete_template

Delete a template from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
templateIdstringYesThe unique ID for the template to delete

Output

ParameterTypeDescription
successbooleanWhether the template was successfully deleted

mailchimp_get_campaign_reports

Retrieve a list of campaign reports from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
countstringNoNumber of results (default: 10, max: 1000)
offsetstringNoNumber of results to skip

Output

ParameterTypeDescription
successbooleanWhether the campaign reports were successfully retrieved
outputobjectCampaign reports data
reportsjsonArray of campaign report objects
total_itemsnumberTotal number of reports
total_returnednumberNumber of reports returned in this response

mailchimp_get_campaign_report

Retrieve the report for a specific campaign from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignIdstringYesThe unique ID for the campaign

Output

ParameterTypeDescription
successbooleanWhether the campaign report was successfully retrieved
outputobjectCampaign report data
reportjsonCampaign report object
campaign_idstringThe unique ID of the campaign

mailchimp_get_segments

Retrieve a list of segments from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
countstringNoNumber of results (default: 10, max: 1000)
offsetstringNoNumber of results to skip

Output

ParameterTypeDescription
successbooleanWhether the segments were successfully retrieved
outputobjectSegments data
segmentsjsonArray of segment objects
total_itemsnumberTotal number of segments
total_returnednumberNumber of segments returned in this response

mailchimp_get_segment

Retrieve details of a specific segment from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
segmentIdstringYesThe unique ID for the segment

Output

ParameterTypeDescription
successbooleanWhether the segment was successfully retrieved
outputobjectSegment data
segmentjsonSegment object
segment_idstringThe unique ID of the segment

mailchimp_create_segment

Create a new segment in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
segmentNamestringYesThe name of the segment
segmentOptionsstringNoJSON object of segment options

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectCreated segment data
segmentjsonCreated segment object
segment_idstringCreated segment ID
successbooleanOperation success

mailchimp_update_segment

Update an existing segment in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
segmentIdstringYesThe unique ID for the segment
segmentNamestringNoThe name of the segment
segmentOptionsstringNoJSON object of segment options

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectUpdated segment data
segmentobjectUpdated segment object
segment_idstringSegment ID
successbooleanOperation success

mailchimp_delete_segment

Delete a segment from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
segmentIdstringYesThe unique ID for the segment to delete

Output

ParameterTypeDescription
successbooleanWhether the segment was successfully deleted

mailchimp_get_segment_members

Retrieve members of a specific segment from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
segmentIdstringYesThe unique ID for the segment
countstringNoNumber of results (default: 10, max: 1000)
offsetstringNoNumber of results to skip

Output

ParameterTypeDescription
successbooleanWhether the segment members were successfully retrieved
outputobjectSegment members data
membersjsonArray of member objects
total_itemsnumberTotal number of members
total_returnednumberNumber of members returned in this response

mailchimp_add_segment_member

Add a member to a specific segment in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
segmentIdstringYesThe unique ID for the segment
emailAddressstringYesEmail address of the member

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectAdded member data
memberjsonAdded member object
successbooleanOperation success

mailchimp_remove_segment_member

Remove a member from a specific segment in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
segmentIdstringYesThe unique ID for the segment
subscriberEmailstringYesMember email address or MD5 hash

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectRemoval confirmation
successbooleanOperation success

mailchimp_get_member_tags

Retrieve tags associated with a member in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
subscriberEmailstringYesMember email address or MD5 hash

Output

ParameterTypeDescription
successbooleanWhether the member tags were successfully retrieved
outputobjectMember tags data
tagsjsonArray of tag objects
total_itemsnumberTotal number of tags
total_returnednumberNumber of tags returned in this response

mailchimp_add_member_tags

Add tags to a member in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
subscriberEmailstringYesMember email address or MD5 hash
tagsstringYesJSON array of tags

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectTag addition confirmation
successbooleanOperation success

mailchimp_remove_member_tags

Remove tags from a member in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
subscriberEmailstringYesMember email address or MD5 hash
tagsstringYesJSON array of tags with inactive status

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectTag removal confirmation
successbooleanOperation success

mailchimp_get_merge_fields

Retrieve a list of merge fields from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
countstringNoNumber of results (default: 10, max: 1000)
offsetstringNoNumber of results to skip

Output

ParameterTypeDescription
successbooleanWhether the merge fields were successfully retrieved
outputobjectMerge fields data
mergeFieldsjsonArray of merge field objects
total_itemsnumberTotal number of merge fields
total_returnednumberNumber of merge fields returned in this response

mailchimp_get_merge_field

Retrieve details of a specific merge field from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
mergeIdstringYesThe unique ID for the merge field

Output

ParameterTypeDescription
successbooleanWhether the merge field was successfully retrieved
outputobjectMerge field data
mergeFieldjsonMerge field object
merge_idstringThe unique ID of the merge field

mailchimp_create_merge_field

Create a new merge field in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
mergeNamestringYesThe name of the merge field
mergeTypestringYesThe type of the merge field (text, number, address, phone, date, url, imageurl, radio, dropdown, birthday, zip)

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectCreated merge field data
mergeFieldjsonCreated merge field object
merge_idstringCreated merge field ID
successbooleanOperation success

mailchimp_update_merge_field

Update an existing merge field in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
mergeIdstringYesThe unique ID for the merge field
mergeNamestringNoThe name of the merge field

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectUpdated merge field data
mergeFieldobjectUpdated merge field object
merge_idstringMerge field ID
successbooleanOperation success

mailchimp_delete_merge_field

Delete a merge field from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
mergeIdstringYesThe unique ID for the merge field to delete

Output

ParameterTypeDescription
successbooleanWhether the merge field was successfully deleted

mailchimp_get_interest_categories

Retrieve a list of interest categories from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
countstringNoNumber of results (default: 10, max: 1000)
offsetstringNoNumber of results to skip

Output

ParameterTypeDescription
successbooleanWhether the interest categories were successfully retrieved
outputobjectInterest categories data
categoriesjsonArray of interest category objects
total_itemsnumberTotal number of categories
total_returnednumberNumber of categories returned in this response

mailchimp_get_interest_category

Retrieve details of a specific interest category from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
interestCategoryIdstringYesThe unique ID for the interest category

Output

ParameterTypeDescription
successbooleanWhether the interest category was successfully retrieved
outputobjectInterest category data
categoryjsonInterest category object
interest_category_idstringThe unique ID of the interest category

mailchimp_create_interest_category

Create a new interest category in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
interestCategoryTitlestringYesThe title of the interest category
interestCategoryTypestringYesThe type of interest category (checkboxes, dropdown, radio, hidden)

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectCreated interest category data
categoryjsonCreated interest category object
interest_category_idstringCreated interest category ID
successbooleanOperation success

mailchimp_update_interest_category

Update an existing interest category in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
interestCategoryIdstringYesThe unique ID for the interest category
interestCategoryTitlestringNoThe title of the interest category

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectUpdated interest category data
categoryobjectUpdated interest category object
interest_category_idstringInterest category ID
successbooleanOperation success

mailchimp_delete_interest_category

Delete an interest category from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
interestCategoryIdstringYesThe unique ID for the interest category to delete

Output

ParameterTypeDescription
successbooleanWhether the interest category was successfully deleted

mailchimp_get_interests

Retrieve a list of interests from an interest category in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
interestCategoryIdstringYesThe unique ID for the interest category
countstringNoNumber of results (default: 10, max: 1000)
offsetstringNoNumber of results to skip

Output

ParameterTypeDescription
successbooleanWhether the interests were successfully retrieved
outputobjectInterests data
interestsjsonArray of interest objects
total_itemsnumberTotal number of interests
total_returnednumberNumber of interests returned in this response

mailchimp_get_interest

Retrieve details of a specific interest from an interest category in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
interestCategoryIdstringYesThe unique ID for the interest category
interestIdstringYesThe unique ID for the interest

Output

ParameterTypeDescription
successbooleanWhether the interest was successfully retrieved
outputobjectInterest data
interestjsonInterest object
interest_idstringThe unique ID of the interest

mailchimp_create_interest

Create a new interest in an interest category in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
interestCategoryIdstringYesThe unique ID for the interest category
interestNamestringYesThe name of the interest

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectCreated interest data
interestjsonCreated interest object
interest_idstringCreated interest ID
successbooleanOperation success

mailchimp_update_interest

Update an existing interest in an interest category in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
interestCategoryIdstringYesThe unique ID for the interest category
interestIdstringYesThe unique ID for the interest
interestNamestringNoThe name of the interest

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectUpdated interest data
interestobjectUpdated interest object
interest_idstringInterest ID
successbooleanOperation success

mailchimp_delete_interest

Delete an interest from an interest category in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the list
interestCategoryIdstringYesThe unique ID for the interest category
interestIdstringYesThe unique ID for the interest to delete

Output

ParameterTypeDescription
successbooleanWhether the interest was successfully deleted

mailchimp_get_landing_pages

Retrieve a list of landing pages from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
countstringNoNumber of results (default: 10, max: 1000)
offsetstringNoNumber of results to skip

Output

ParameterTypeDescription
successbooleanWhether the landing pages were successfully retrieved
outputobjectLanding pages data
landingPagesjsonArray of landing page objects
total_itemsnumberTotal number of landing pages
total_returnednumberNumber of landing pages returned in this response

mailchimp_get_landing_page

Retrieve details of a specific landing page from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
pageIdstringYesThe unique ID for the landing page

Output

ParameterTypeDescription
successbooleanWhether the landing page was successfully retrieved
outputobjectLanding page data
landingPagejsonLanding page object
page_idstringThe unique ID of the landing page

mailchimp_create_landing_page

Create a new landing page in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
landingPageTypestringYesThe type of landing page (signup)
landingPageTitlestringNoThe title of the landing page

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectCreated landing page data
landingPagejsonCreated landing page object
page_idstringCreated landing page ID
successbooleanOperation success

mailchimp_update_landing_page

Update an existing landing page in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
pageIdstringYesThe unique ID for the landing page
landingPageTitlestringNoThe title of the landing page

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectUpdated landing page data
landingPageobjectUpdated landing page object
page_idstringLanding page ID
successbooleanOperation success

mailchimp_delete_landing_page

Delete a landing page from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
pageIdstringYesThe unique ID for the landing page to delete

Output

ParameterTypeDescription
successbooleanWhether the landing page was successfully deleted

mailchimp_publish_landing_page

Publish a landing page in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
pageIdstringYesThe unique ID for the landing page

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectPublish confirmation
successbooleanOperation success

mailchimp_unpublish_landing_page

Unpublish a landing page in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
pageIdstringYesThe unique ID for the landing page

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectUnpublish confirmation
successbooleanOperation success

mailchimp_get_batch_operations

Retrieve a list of batch operations from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
countstringNoNumber of results (default: 10, max: 1000)
offsetstringNoNumber of results to skip

Output

ParameterTypeDescription
successbooleanWhether the batch operations were successfully retrieved
outputobjectBatch operations data
batchesjsonArray of batch operation objects
total_itemsnumberTotal number of batch operations
total_returnednumberNumber of batch operations returned in this response

mailchimp_get_batch_operation

Retrieve details of a specific batch operation from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
batchIdstringYesThe unique ID for the batch operation

Output

ParameterTypeDescription
successbooleanWhether the batch operation was successfully retrieved
outputobjectBatch operation data
batchjsonBatch operation object
batch_idstringThe unique ID of the batch operation

mailchimp_create_batch_operation

Create a new batch operation in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
operationsstringYesJSON array of operations

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectCreated batch operation data
batchjsonCreated batch operation object
batch_idstringCreated batch operation ID
successbooleanOperation success

mailchimp_delete_batch_operation

Delete a batch operation from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
batchIdstringYesThe unique ID for the batch operation to delete

Output

ParameterTypeDescription
successbooleanWhether the batch operation was successfully deleted
On this page

On this page

Usage Instructions
Tools
mailchimp_get_audiences
Input
Output
mailchimp_get_audience
Input
Output
mailchimp_create_audience
Input
Output
mailchimp_update_audience
Input
Output
mailchimp_delete_audience
Input
Output
mailchimp_get_members
Input
Output
mailchimp_get_member
Input
Output
mailchimp_add_member
Input
Output
mailchimp_add_or_update_member
Input
Output
mailchimp_update_member
Input
Output
mailchimp_delete_member
Input
Output
mailchimp_archive_member
Input
Output
mailchimp_unarchive_member
Input
Output
mailchimp_get_campaigns
Input
Output
mailchimp_get_campaign
Input
Output
mailchimp_create_campaign
Input
Output
mailchimp_update_campaign
Input
Output
mailchimp_delete_campaign
Input
Output
mailchimp_send_campaign
Input
Output
mailchimp_schedule_campaign
Input
Output
mailchimp_unschedule_campaign
Input
Output
mailchimp_replicate_campaign
Input
Output
mailchimp_get_campaign_content
Input
Output
mailchimp_set_campaign_content
Input
Output
mailchimp_get_automations
Input
Output
mailchimp_get_automation
Input
Output
mailchimp_start_automation
Input
Output
mailchimp_pause_automation
Input
Output
mailchimp_add_subscriber_to_automation
Input
Output
mailchimp_get_templates
Input
Output
mailchimp_get_template
Input
Output
mailchimp_create_template
Input
Output
mailchimp_update_template
Input
Output
mailchimp_delete_template
Input
Output
mailchimp_get_campaign_reports
Input
Output
mailchimp_get_campaign_report
Input
Output
mailchimp_get_segments
Input
Output
mailchimp_get_segment
Input
Output
mailchimp_create_segment
Input
Output
mailchimp_update_segment
Input
Output
mailchimp_delete_segment
Input
Output
mailchimp_get_segment_members
Input
Output
mailchimp_add_segment_member
Input
Output
mailchimp_remove_segment_member
Input
Output
mailchimp_get_member_tags
Input
Output
mailchimp_add_member_tags
Input
Output
mailchimp_remove_member_tags
Input
Output
mailchimp_get_merge_fields
Input
Output
mailchimp_get_merge_field
Input
Output
mailchimp_create_merge_field
Input
Output
mailchimp_update_merge_field
Input
Output
mailchimp_delete_merge_field
Input
Output
mailchimp_get_interest_categories
Input
Output
mailchimp_get_interest_category
Input
Output
mailchimp_create_interest_category
Input
Output
mailchimp_update_interest_category
Input
Output
mailchimp_delete_interest_category
Input
Output
mailchimp_get_interests
Input
Output
mailchimp_get_interest
Input
Output
mailchimp_create_interest
Input
Output
mailchimp_update_interest
Input
Output
mailchimp_delete_interest
Input
Output
mailchimp_get_landing_pages
Input
Output
mailchimp_get_landing_page
Input
Output
mailchimp_create_landing_page
Input
Output
mailchimp_update_landing_page
Input
Output
mailchimp_delete_landing_page
Input
Output
mailchimp_publish_landing_page
Input
Output
mailchimp_unpublish_landing_page
Input
Output
mailchimp_get_batch_operations
Input
Output
mailchimp_get_batch_operation
Input
Output
mailchimp_create_batch_operation
Input
Output
mailchimp_delete_batch_operation
Input
Output
Start building today
Trusted by over 60,000 builders.
Build Agentic workflows visually on a drag-and-drop canvas or with natural language.
Get started