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.

Actions

Get Audiences from Mailchimp

Retrieve a list of audiences (lists) from Mailchimp

Input

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

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

Get Audience from Mailchimp

Retrieve details of a specific audience (list) from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")

Output

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

Create Audience in Mailchimp

Create a new audience (list) in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
audienceNamestringYesThe name of the audience/list (e.g., "Newsletter Subscribers")
contactstringYesJSON object of contact information (e.g., {"company": "Acme", "address1": "123 Main St", "city": "NYC", "state": "NY", "zip": "10001", "country": "US"})
permissionReminderstringYesPermission reminder text shown to subscribers (e.g., "You signed up for updates on our website")
campaignDefaultsstringYesJSON object of default campaign settings (e.g., {"from_name": "Acme", "from_email": "news@acme.com", "subject": "", "language": "en"})
emailTypeOptionstringYesSupport multiple email formats: "true" or "false"

Output

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

Update Audience in Mailchimp

Update an existing audience (list) in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
audienceNamestringNoThe name of the audience/list (e.g., "Newsletter Subscribers")
permissionReminderstringNoPermission reminder text shown to subscribers (e.g., "You signed up for updates on our website")
campaignDefaultsstringNoJSON object of default campaign settings (e.g., {"from_name": "Acme", "from_email": "news@acme.com"})
emailTypeOptionstringNoSupport multiple email formats: "true" or "false"

Output

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

Delete Audience from Mailchimp

Delete an audience (list) from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list to delete (e.g., "abc123def4")

Output

ParameterTypeDescription
successbooleanWhether the audience was successfully deleted

Get Members from Mailchimp Audience

Retrieve a list of members from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
statusstringNoFilter by status: "subscribed", "unsubscribed", "cleaned", or "pending"
countstringNoNumber of results to return (default: 10, max: 1000)
offsetstringNoNumber of results to skip for pagination

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

Get Member from Mailchimp Audience

Retrieve details of a specific member from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
subscriberEmailstringYesMember email address or MD5 hash of the lowercase email

Output

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

Add Member to Mailchimp Audience

Add a new member to a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
emailAddressstringYesMember email address (e.g., "user@example.com")
statusstringYesSubscriber status: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional"
mergeFieldsstringNoJSON object of merge fields (e.g., {"FNAME": "John", "LNAME": "Doe"})
interestsstringNoJSON object of interest IDs and their boolean values (e.g., {"abc123": true})

Output

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

Add or Update Member in Mailchimp Audience

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 audience/list (e.g., "abc123def4")
subscriberEmailstringYesMember email address or MD5 hash of the lowercase email
emailAddressstringYesMember email address (e.g., "user@example.com")
statusIfNewstringYesSubscriber status if new: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional"
mergeFieldsstringNoJSON object of merge fields (e.g., {"FNAME": "John", "LNAME": "Doe"})
interestsstringNoJSON object of interest IDs and their boolean values (e.g., {"abc123": true})

Output

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

Update Member in Mailchimp Audience

Update an existing member in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
subscriberEmailstringYesMember email address or MD5 hash of the lowercase email
emailAddressstringNoNew member email address (e.g., "user@example.com")
statusstringNoSubscriber status: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional"
mergeFieldsstringNoJSON object of merge fields (e.g., {"FNAME": "John", "LNAME": "Doe"})
interestsstringNoJSON object of interest IDs and their boolean values (e.g., {"abc123": true})

Output

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

Delete Member from Mailchimp Audience

Delete a member from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
subscriberEmailstringYesMember email address or MD5 hash of the lowercase email

Output

ParameterTypeDescription
successbooleanWhether the member was successfully deleted

Archive Member from Mailchimp Audience

Permanently archive (delete) a member from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
subscriberEmailstringYesMember email address or MD5 hash of the lowercase email

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectArchive confirmation
successbooleanOperation success

Unarchive Member in Mailchimp Audience

Restore an archived member to a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
subscriberEmailstringYesMember email address or MD5 hash of the lowercase email
emailAddressstringYesMember email address (e.g., "user@example.com")
statusstringYesSubscriber status: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional"

Output

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

Get Campaigns from Mailchimp

Retrieve a list of campaigns from Mailchimp

Input

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

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

Get Campaign from Mailchimp

Retrieve details of a specific campaign from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignIdstringYesThe unique ID for the campaign (e.g., "abc123def4")

Output

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

Create Campaign in Mailchimp

Create a new campaign in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignTypestringYesCampaign type: "regular", "plaintext", "absplit", "rss", or "variate"
campaignSettingsstringYesJSON object of campaign settings (e.g., {"subject_line": "Newsletter", "from_name": "Acme", "reply_to": "news@acme.com"})
recipientsstringNoJSON object of recipients (e.g., {"list_id": "abc123"})

Output

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

Update Campaign in Mailchimp

Update an existing campaign in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignIdstringYesThe unique ID for the campaign (e.g., "abc123def4")
campaignSettingsstringNoJSON object of campaign settings (e.g., {"subject_line": "Newsletter", "from_name": "Acme"})
recipientsstringNoJSON object of recipients (e.g., {"list_id": "abc123"})

Output

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

Delete Campaign from Mailchimp

Delete a campaign from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignIdstringYesThe unique ID for the campaign to delete (e.g., "abc123def4")

Output

ParameterTypeDescription
successbooleanWhether the campaign was successfully deleted

Send Campaign in Mailchimp

Send a Mailchimp campaign

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignIdstringYesThe unique ID for the campaign to send (e.g., "abc123def4")

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectSend confirmation
successbooleanOperation success

Schedule Campaign in Mailchimp

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 (e.g., "abc123def4")
scheduleTimestringYesSchedule time in ISO 8601 format (e.g., "2024-12-25T10:00:00Z")

Output

ParameterTypeDescription
successbooleanWhether the campaign was successfully scheduled

Unschedule Campaign in Mailchimp

Unschedule a previously scheduled Mailchimp campaign

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignIdstringYesThe unique ID for the campaign to unschedule (e.g., "abc123def4")

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectUnschedule confirmation
successbooleanOperation success

Replicate Campaign in Mailchimp

Create a copy of an existing Mailchimp campaign

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignIdstringYesThe unique ID for the campaign to replicate (e.g., "abc123def4")

Output

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

Get Campaign Content from Mailchimp

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 (e.g., "abc123def4")

Output

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

Set Campaign Content in Mailchimp

Set the content for a Mailchimp campaign

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignIdstringYesThe unique ID for the campaign (e.g., "abc123def4")
htmlstringNoThe HTML content for the campaign
plainTextstringNoThe plain-text content for the campaign
templateIdstringNoThe unique ID of the template to use (e.g., "12345")

Output

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

Get Automations from Mailchimp

Retrieve a list of automations from Mailchimp

Input

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

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

Get Automation from Mailchimp

Retrieve details of a specific automation from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
workflowIdstringYesThe unique ID for the automation workflow (e.g., "abc123def4")

Output

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

Start Automation in Mailchimp

Start all emails in a Mailchimp automation workflow

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
workflowIdstringYesThe unique ID for the automation workflow (e.g., "abc123def4")

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectStart confirmation
successbooleanOperation success

Pause Automation in Mailchimp

Pause all emails in a Mailchimp automation workflow

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
workflowIdstringYesThe unique ID for the automation workflow (e.g., "abc123def4")

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectPause confirmation
successbooleanOperation success

Add Subscriber to Automation in Mailchimp

Manually add a subscriber to a workflow email queue

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
workflowIdstringYesThe unique ID for the automation workflow (e.g., "abc123def4")
workflowEmailIdstringYesThe unique ID for the workflow email (e.g., "xyz789")
emailAddressstringYesEmail address of the subscriber (e.g., "user@example.com")

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectSubscriber queue data
subscriberjsonSubscriber object
successbooleanOperation success

Get Templates from Mailchimp

Retrieve a list of templates from Mailchimp

Input

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

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

Get Template from Mailchimp

Retrieve details of a specific template from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
templateIdstringYesThe unique ID for the template (e.g., "12345")

Output

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

Create Template in Mailchimp

Create a new template in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
templateNamestringYesThe name of the template (e.g., "Monthly Newsletter")
templateHtmlstringYesThe HTML content for the template

Output

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

Update Template in Mailchimp

Update an existing template in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
templateIdstringYesThe unique ID for the template (e.g., "12345")
templateNamestringNoThe name of the template (e.g., "Monthly Newsletter")
templateHtmlstringNoThe HTML content for the template

Output

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

Delete Template from Mailchimp

Delete a template from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
templateIdstringYesThe unique ID for the template to delete (e.g., "12345")

Output

ParameterTypeDescription
successbooleanWhether the template was successfully deleted

Get Campaign Reports from Mailchimp

Retrieve a list of campaign reports from Mailchimp

Input

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

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

Get Campaign Report from Mailchimp

Retrieve the report for a specific campaign from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
campaignIdstringYesThe unique ID for the campaign (e.g., "abc123def4")

Output

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

Get Segments from Mailchimp Audience

Retrieve a list of segments from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
countstringNoNumber of results to return (default: 10, max: 1000)
offsetstringNoNumber of results to skip for pagination

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

Get Segment from Mailchimp Audience

Retrieve details of a specific segment from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
segmentIdstringYesThe unique ID for the segment (e.g., "12345")

Output

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

Create Segment in Mailchimp Audience

Create a new segment in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
segmentNamestringYesThe name of the segment (e.g., "VIP Customers")
segmentOptionsstringNoJSON object of segment options for saved segments (e.g., {"match": "all", "conditions": [...]})

Output

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

Update Segment in Mailchimp Audience

Update an existing segment in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
segmentIdstringYesThe unique ID for the segment (e.g., "12345")
segmentNamestringNoThe name of the segment (e.g., "VIP Customers")
segmentOptionsstringNoJSON object of segment options (e.g., {"match": "all", "conditions": [...]})

Output

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

Delete Segment from Mailchimp Audience

Delete a segment from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
segmentIdstringYesThe unique ID for the segment to delete (e.g., "12345")

Output

ParameterTypeDescription
successbooleanWhether the segment was successfully deleted

Get Segment Members from Mailchimp

Retrieve members of a specific segment from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
segmentIdstringYesThe unique ID for the segment (e.g., "12345")
countstringNoNumber of results to return (default: 10, max: 1000)
offsetstringNoNumber of results to skip for pagination

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

Add Member to Segment in Mailchimp

Add a member to a specific segment in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
segmentIdstringYesThe unique ID for the segment (e.g., "12345")
emailAddressstringYesEmail address of the member (e.g., "user@example.com")

Output

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

Remove Member from Segment in Mailchimp

Remove a member from a specific segment in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
segmentIdstringYesThe unique ID for the segment (e.g., "12345")
subscriberEmailstringYesMember email address or MD5 hash of the lowercase email

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectRemoval confirmation
successbooleanOperation success

Get Member Tags from Mailchimp

Retrieve tags associated with a member in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
subscriberEmailstringYesMember email address or MD5 hash of the lowercase email

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

Add Tags to Member in Mailchimp

Add tags to a member in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
subscriberEmailstringYesMember email address or MD5 hash of the lowercase email
tagsstringYesJSON array of tag objects (e.g., [{"name": "VIP", "status": "active"}])

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectTag addition confirmation
successbooleanOperation success

Remove Tags from Member in Mailchimp

Remove tags from a member in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
subscriberEmailstringYesMember email address or MD5 hash of the lowercase email
tagsstringYesJSON array of tag objects with inactive status (e.g., [{"name": "VIP", "status": "inactive"}])

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectTag removal confirmation
successbooleanOperation success

Get Merge Fields from Mailchimp Audience

Retrieve a list of merge fields from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
countstringNoNumber of results to return (default: 10, max: 1000)
offsetstringNoNumber of results to skip for pagination

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

Get Merge Field from Mailchimp Audience

Retrieve details of a specific merge field from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
mergeIdstringYesThe unique ID for the merge field (e.g., "1" or "FNAME")

Output

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

Create Merge Field in Mailchimp Audience

Create a new merge field in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
mergeNamestringYesThe name of the merge field (e.g., "First Name")
mergeTypestringYesThe type of the merge field: "text", "number", "address", "phone", "date", "url", "imageurl", "radio", "dropdown", "birthday", or "zip"

Output

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

Update Merge Field in Mailchimp Audience

Update an existing merge field in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
mergeIdstringYesThe unique ID for the merge field (e.g., "1" or "FNAME")
mergeNamestringNoThe name of the merge field (e.g., "First Name")

Output

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

Delete Merge Field from Mailchimp Audience

Delete a merge field from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
mergeIdstringYesThe unique ID for the merge field to delete (e.g., "1" or "FNAME")

Output

ParameterTypeDescription
successbooleanWhether the merge field was successfully deleted

Get Interest Categories from Mailchimp Audience

Retrieve a list of interest categories from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
countstringNoNumber of results to return (default: 10, max: 1000)
offsetstringNoNumber of results to skip for pagination

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

Get Interest Category from Mailchimp Audience

Retrieve details of a specific interest category from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
interestCategoryIdstringYesThe unique ID for the interest category (e.g., "xyz789")

Output

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

Create Interest Category in Mailchimp Audience

Create a new interest category in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
interestCategoryTitlestringYesThe title of the interest category (e.g., "Email Preferences")
interestCategoryTypestringYesThe type of interest category: "checkboxes", "dropdown", "radio", or "hidden"

Output

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

Update Interest Category in Mailchimp Audience

Update an existing interest category in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
interestCategoryIdstringYesThe unique ID for the interest category (e.g., "xyz789")
interestCategoryTitlestringNoThe title of the interest category (e.g., "Email Preferences")

Output

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

Delete Interest Category from Mailchimp Audience

Delete an interest category from a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
interestCategoryIdstringYesThe unique ID for the interest category to delete (e.g., "xyz789")

Output

ParameterTypeDescription
successbooleanWhether the interest category was successfully deleted

Get Interests from Mailchimp Interest Category

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 audience/list (e.g., "abc123def4")
interestCategoryIdstringYesThe unique ID for the interest category (e.g., "xyz789")
countstringNoNumber of results to return (default: 10, max: 1000)
offsetstringNoNumber of results to skip for pagination

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

Get Interest from Mailchimp Interest Category

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 audience/list (e.g., "abc123def4")
interestCategoryIdstringYesThe unique ID for the interest category (e.g., "xyz789")
interestIdstringYesThe unique ID for the interest (e.g., "def456")

Output

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

Create Interest in Mailchimp Interest Category

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 audience/list (e.g., "abc123def4")
interestCategoryIdstringYesThe unique ID for the interest category (e.g., "xyz789")
interestNamestringYesThe name of the interest (e.g., "Weekly Updates")

Output

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

Update Interest in Mailchimp Interest Category

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 audience/list (e.g., "abc123def4")
interestCategoryIdstringYesThe unique ID for the interest category (e.g., "xyz789")
interestIdstringYesThe unique ID for the interest (e.g., "def456")
interestNamestringNoThe name of the interest (e.g., "Weekly Updates")

Output

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

Delete Interest from Mailchimp Interest Category

Delete an interest from an interest category in a Mailchimp audience

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
listIdstringYesThe unique ID for the audience/list (e.g., "abc123def4")
interestCategoryIdstringYesThe unique ID for the interest category (e.g., "xyz789")
interestIdstringYesThe unique ID for the interest to delete (e.g., "def456")

Output

ParameterTypeDescription
successbooleanWhether the interest was successfully deleted

Get Landing Pages from Mailchimp

Retrieve a list of landing pages from Mailchimp

Input

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

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

Get Landing Page from Mailchimp

Retrieve details of a specific landing page from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
pageIdstringYesThe unique ID for the landing page (e.g., "abc123def4")

Output

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

Create Landing Page in Mailchimp

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 (e.g., "Join Our Newsletter")

Output

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

Update Landing Page in Mailchimp

Update an existing landing page in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
pageIdstringYesThe unique ID for the landing page (e.g., "abc123def4")
landingPageTitlestringNoThe title of the landing page (e.g., "Join Our Newsletter")

Output

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

Delete Landing Page from Mailchimp

Delete a landing page from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
pageIdstringYesThe unique ID for the landing page to delete (e.g., "abc123def4")

Output

ParameterTypeDescription
successbooleanWhether the landing page was successfully deleted

Publish Landing Page in Mailchimp

Publish a landing page in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
pageIdstringYesThe unique ID for the landing page (e.g., "abc123def4")

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectPublish confirmation
successbooleanOperation success

Unpublish Landing Page in Mailchimp

Unpublish a landing page in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
pageIdstringYesThe unique ID for the landing page (e.g., "abc123def4")

Output

ParameterTypeDescription
successbooleanOperation success status
outputobjectUnpublish confirmation
successbooleanOperation success

Get Batch Operations from Mailchimp

Retrieve a list of batch operations from Mailchimp

Input

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

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

Get Batch Operation from Mailchimp

Retrieve details of a specific batch operation from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
batchIdstringYesThe unique ID for the batch operation (e.g., "abc123def4")

Output

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

Create Batch Operation in Mailchimp

Create a new batch operation in Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
operationsstringYesJSON array of batch operations (e.g., [{"method": "POST", "path": "/lists/{list_id}/members", "body": "..."}])

Output

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

Delete Batch Operation from Mailchimp

Delete a batch operation from Mailchimp

Input

ParameterTypeRequiredDescription
apiKeystringYesMailchimp API key with server prefix
batchIdstringYesThe unique ID for the batch operation to delete (e.g., "abc123def4")

Output

ParameterTypeDescription
successbooleanWhether the batch operation was successfully deleted

On this page

Usage Instructions
Actions
Get Audiences from Mailchimp
Input
Output
Get Audience from Mailchimp
Input
Output
Create Audience in Mailchimp
Input
Output
Update Audience in Mailchimp
Input
Output
Delete Audience from Mailchimp
Input
Output
Get Members from Mailchimp Audience
Input
Output
Get Member from Mailchimp Audience
Input
Output
Add Member to Mailchimp Audience
Input
Output
Add or Update Member in Mailchimp Audience
Input
Output
Update Member in Mailchimp Audience
Input
Output
Delete Member from Mailchimp Audience
Input
Output
Archive Member from Mailchimp Audience
Input
Output
Unarchive Member in Mailchimp Audience
Input
Output
Get Campaigns from Mailchimp
Input
Output
Get Campaign from Mailchimp
Input
Output
Create Campaign in Mailchimp
Input
Output
Update Campaign in Mailchimp
Input
Output
Delete Campaign from Mailchimp
Input
Output
Send Campaign in Mailchimp
Input
Output
Schedule Campaign in Mailchimp
Input
Output
Unschedule Campaign in Mailchimp
Input
Output
Replicate Campaign in Mailchimp
Input
Output
Get Campaign Content from Mailchimp
Input
Output
Set Campaign Content in Mailchimp
Input
Output
Get Automations from Mailchimp
Input
Output
Get Automation from Mailchimp
Input
Output
Start Automation in Mailchimp
Input
Output
Pause Automation in Mailchimp
Input
Output
Add Subscriber to Automation in Mailchimp
Input
Output
Get Templates from Mailchimp
Input
Output
Get Template from Mailchimp
Input
Output
Create Template in Mailchimp
Input
Output
Update Template in Mailchimp
Input
Output
Delete Template from Mailchimp
Input
Output
Get Campaign Reports from Mailchimp
Input
Output
Get Campaign Report from Mailchimp
Input
Output
Get Segments from Mailchimp Audience
Input
Output
Get Segment from Mailchimp Audience
Input
Output
Create Segment in Mailchimp Audience
Input
Output
Update Segment in Mailchimp Audience
Input
Output
Delete Segment from Mailchimp Audience
Input
Output
Get Segment Members from Mailchimp
Input
Output
Add Member to Segment in Mailchimp
Input
Output
Remove Member from Segment in Mailchimp
Input
Output
Get Member Tags from Mailchimp
Input
Output
Add Tags to Member in Mailchimp
Input
Output
Remove Tags from Member in Mailchimp
Input
Output
Get Merge Fields from Mailchimp Audience
Input
Output
Get Merge Field from Mailchimp Audience
Input
Output
Create Merge Field in Mailchimp Audience
Input
Output
Update Merge Field in Mailchimp Audience
Input
Output
Delete Merge Field from Mailchimp Audience
Input
Output
Get Interest Categories from Mailchimp Audience
Input
Output
Get Interest Category from Mailchimp Audience
Input
Output
Create Interest Category in Mailchimp Audience
Input
Output
Update Interest Category in Mailchimp Audience
Input
Output
Delete Interest Category from Mailchimp Audience
Input
Output
Get Interests from Mailchimp Interest Category
Input
Output
Get Interest from Mailchimp Interest Category
Input
Output
Create Interest in Mailchimp Interest Category
Input
Output
Update Interest in Mailchimp Interest Category
Input
Output
Delete Interest from Mailchimp Interest Category
Input
Output
Get Landing Pages from Mailchimp
Input
Output
Get Landing Page from Mailchimp
Input
Output
Create Landing Page in Mailchimp
Input
Output
Update Landing Page in Mailchimp
Input
Output
Delete Landing Page from Mailchimp
Input
Output
Publish Landing Page in Mailchimp
Input
Output
Unpublish Landing Page in Mailchimp
Input
Output
Get Batch Operations from Mailchimp
Input
Output
Get Batch Operation from Mailchimp
Input
Output
Create Batch Operation in Mailchimp
Input
Output
Delete Batch Operation from Mailchimp
Input
Output