Mailchimp

Use Mailchimp in Sim to manage audiences and members, campaigns, automations, templates, segments, tags, and reports. The actions below also cover merge fields, interest categories, landing pages, signup forms, and batch operations.

Member removal

Delete Member from Mailchimp Audience calls Mailchimp's reversible archive endpoint. Archive Member from Mailchimp Audience instead targets permanent deletion of identifying data, after which the member cannot be re-imported. These UI labels differ from the provider's terminology.

The current permanent-deletion action sends DELETE, while Mailchimp documents POST for delete-permanent. Its compatibility is unverified; do not rely on it for deletion until the request method is corrected and tested.

Use the block

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

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
count	string	No	Number of results to return (default: 10, max: 1000)
offset	string	No	Number of results to skip for pagination

Output

Parameter	Type	Description
success	boolean	Whether the audiences were successfully retrieved
output	object	Audiences data
↳ lists	json	Array of audience/list objects
↳ total_items	number	Total number of lists
↳ total_returned	number	Number of lists returned in this response

Get Audience from Mailchimp

Retrieve details of a specific audience (list) from Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")

Output

Parameter	Type	Description
success	boolean	Whether the audience was successfully retrieved
output	object	Audience data
↳ list	json	Audience/list object
↳ list_id	string	The unique ID of the audience

Create Audience in Mailchimp

Create a new audience (list) in Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
audienceName	string	Yes	The name of the audience/list (e.g., "Newsletter Subscribers")
contact	string	Yes	JSON object of contact information (e.g., {"company": "Acme", "address1": "123 Main St", "city": "NYC", "state": "NY", "zip": "10001", "country": "US"})
permissionReminder	string	Yes	Permission reminder text shown to subscribers (e.g., "You signed up for updates on our website")
campaignDefaults	string	Yes	JSON object of default campaign settings (e.g., {"from_name": "Acme", "from_email": "news@acme.com", "subject": "", "language": "en"})
emailTypeOption	string	Yes	Support multiple email formats: "true" or "false"

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Created audience data
↳ list	json	Created audience/list object
↳ list_id	string	Created audience/list ID
↳ success	boolean	Operation success

Update Audience in Mailchimp

Update an existing audience (list) in Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
audienceName	string	No	The name of the audience/list (e.g., "Newsletter Subscribers")
permissionReminder	string	No	Permission reminder text shown to subscribers (e.g., "You signed up for updates on our website")
campaignDefaults	string	No	JSON object of default campaign settings (e.g., {"from_name": "Acme", "from_email": "news@acme.com"})
emailTypeOption	string	No	Support multiple email formats: "true" or "false"

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Updated audience data
↳ list	object	Updated audience/list object
↳ list_id	string	List ID
↳ success	boolean	Operation success

Delete Audience from Mailchimp

Delete an audience (list) from Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list to delete (e.g., "abc123def4")

Output

Parameter	Type	Description
success	boolean	Whether the audience was successfully deleted

Get Members from Mailchimp Audience

Retrieve a list of members from a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
status	string	No	Filter by status: "subscribed", "unsubscribed", "cleaned", or "pending"
count	string	No	Number of results to return (default: 10, max: 1000)
offset	string	No	Number of results to skip for pagination

Output

Parameter	Type	Description
success	boolean	Whether the members were successfully retrieved
output	object	Members data
↳ members	json	Array of member objects
↳ total_items	number	Total number of members
↳ total_returned	number	Number of members returned in this response

Get Member from Mailchimp Audience

Retrieve details of a specific member from a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
subscriberEmail	string	Yes	Member email address or MD5 hash of the lowercase email

Output

Parameter	Type	Description
success	boolean	Whether the member was successfully retrieved
output	object	Member data
↳ member	json	Member object
↳ subscriber_hash	string	The MD5 hash of the member email address

Add Member to Mailchimp Audience

Add a new member to a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
emailAddress	string	Yes	Member email address (e.g., "user@example.com")
status	string	Yes	Subscriber status: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional"
mergeFields	string	No	JSON object of merge fields (e.g., {"FNAME": "John", "LNAME": "Doe"})
interests	string	No	JSON object of interest IDs and their boolean values (e.g., {"abc123": true})

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Added member data
↳ member	json	Added member object
↳ subscriber_hash	string	Subscriber hash ID
↳ success	boolean	Operation success

Add or Update Member in Mailchimp Audience

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

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
subscriberEmail	string	Yes	Member email address or MD5 hash of the lowercase email
emailAddress	string	Yes	Member email address (e.g., "user@example.com")
statusIfNew	string	Yes	Subscriber status if new: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional"
mergeFields	string	No	JSON object of merge fields (e.g., {"FNAME": "John", "LNAME": "Doe"})
interests	string	No	JSON object of interest IDs and their boolean values (e.g., {"abc123": true})

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Member data
↳ member	json	Member object
↳ subscriber_hash	string	Subscriber hash ID
↳ success	boolean	Operation success

Update Member in Mailchimp Audience

Update an existing member in a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
subscriberEmail	string	Yes	Member email address or MD5 hash of the lowercase email
emailAddress	string	No	New member email address (e.g., "user@example.com")
status	string	No	Subscriber status: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional"
mergeFields	string	No	JSON object of merge fields (e.g., {"FNAME": "John", "LNAME": "Doe"})
interests	string	No	JSON object of interest IDs and their boolean values (e.g., {"abc123": true})

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Updated member data
↳ member	object	Updated member object
↳ subscriber_hash	string	Subscriber hash
↳ success	boolean	Operation success

Delete Member from Mailchimp Audience

Archive a member from a Mailchimp audience without permanently deleting their data.

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
subscriberEmail	string	Yes	Member email address or MD5 hash of the lowercase email

Output

Parameter	Type	Description
success	boolean	Whether the archive request succeeded

Archive Member from Mailchimp Audience

Request permanent deletion of a member and their identifying data. This targets delete-permanent, despite the Archive Member label; provider acceptance of the current HTTP method is unverified.

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
subscriberEmail	string	Yes	Member email address or MD5 hash of the lowercase email

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Permanent-deletion request confirmation
↳ success	boolean	Operation success

Unarchive Member in Mailchimp Audience

Restore an archived member to a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
subscriberEmail	string	Yes	Member email address or MD5 hash of the lowercase email
emailAddress	string	Yes	Member email address (e.g., "user@example.com")
status	string	Yes	Subscriber status: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional"

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Unarchived member data
↳ member	object	Unarchived member object
↳ subscriber_hash	string	Subscriber hash
↳ success	boolean	Operation success

Get Campaigns from Mailchimp

Retrieve a list of campaigns from Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
campaignType	string	No	Filter by campaign type: "regular", "plaintext", "absplit", "rss", or "variate"
status	string	No	Filter by status: "save", "paused", "schedule", "sending", or "sent"
count	string	No	Number of results to return (default: 10, max: 1000)
offset	string	No	Number of results to skip for pagination

Output

Parameter	Type	Description
success	boolean	Whether the campaigns were successfully retrieved
output	object	Campaigns data
↳ campaigns	json	Array of campaign objects
↳ total_items	number	Total number of campaigns
↳ total_returned	number	Number of campaigns returned in this response

Get Campaign from Mailchimp

Retrieve details of a specific campaign from Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
campaignId	string	Yes	The unique ID for the campaign (e.g., "abc123def4")

Output

Parameter	Type	Description
success	boolean	Whether the campaign was successfully retrieved
output	object	Campaign data
↳ campaign	json	Campaign object
↳ campaign_id	string	The unique ID of the campaign

Create Campaign in Mailchimp

Create a new campaign in Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
campaignType	string	Yes	Campaign type: "regular", "plaintext", "absplit", "rss", or "variate"
campaignSettings	string	Yes	JSON object of campaign settings (e.g., {"subject_line": "Newsletter", "from_name": "Acme", "reply_to": "news@acme.com"})
recipients	string	No	JSON object of recipients (e.g., {"list_id": "abc123"})

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Created campaign data
↳ campaign	json	Created campaign object
↳ campaign_id	string	Created campaign ID
↳ success	boolean	Operation success

Update Campaign in Mailchimp

Update an existing campaign in Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
campaignId	string	Yes	The unique ID for the campaign (e.g., "abc123def4")
campaignSettings	string	No	JSON object of campaign settings (e.g., {"subject_line": "Newsletter", "from_name": "Acme"})
recipients	string	No	JSON object of recipients (e.g., {"list_id": "abc123"})

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Updated campaign data
↳ campaign	object	Updated campaign object
↳ campaign_id	string	Campaign ID
↳ success	boolean	Operation success

Delete Campaign from Mailchimp

Delete a campaign from Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
campaignId	string	Yes	The unique ID for the campaign to delete (e.g., "abc123def4")

Output

Parameter	Type	Description
success	boolean	Whether the campaign was successfully deleted

Send Campaign in Mailchimp

Send a Mailchimp campaign

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
campaignId	string	Yes	The unique ID for the campaign to send (e.g., "abc123def4")

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Send confirmation
↳ success	boolean	Operation success

Schedule Campaign in Mailchimp

Schedule a Mailchimp campaign to be sent at a specific time

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
campaignId	string	Yes	The unique ID for the campaign to schedule (e.g., "abc123def4")
scheduleTime	string	Yes	Schedule time in ISO 8601 format (e.g., "2024-12-25T10:00:00Z")

Output

Parameter	Type	Description
success	boolean	Whether the campaign was successfully scheduled

Unschedule Campaign in Mailchimp

Unschedule a previously scheduled Mailchimp campaign

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
campaignId	string	Yes	The unique ID for the campaign to unschedule (e.g., "abc123def4")

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Unschedule confirmation
↳ success	boolean	Operation success

Replicate Campaign in Mailchimp

Create a copy of an existing Mailchimp campaign

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
campaignId	string	Yes	The unique ID for the campaign to replicate (e.g., "abc123def4")

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Replicated campaign data
↳ campaign	object	Replicated campaign object
↳ campaign_id	string	Campaign ID
↳ success	boolean	Operation success

Get Campaign Content from Mailchimp

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

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
campaignId	string	Yes	The unique ID for the campaign (e.g., "abc123def4")

Output

Parameter	Type	Description
success	boolean	Whether the campaign content was successfully retrieved
output	object	Campaign content data
↳ content	json	Campaign content object

Set Campaign Content in Mailchimp

Set the content for a Mailchimp campaign

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
campaignId	string	Yes	The unique ID for the campaign (e.g., "abc123def4")
html	string	No	The HTML content for the campaign
plainText	string	No	The plain-text content for the campaign
templateId	string	No	The unique ID of the template to use (e.g., "12345")

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Campaign content data
↳ content	object	Campaign content object
↳ success	boolean	Operation success

Get Automations from Mailchimp

Retrieve a list of automations from Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
count	string	No	Number of results to return (default: 10, max: 1000)
offset	string	No	Number of results to skip for pagination

Output

Parameter	Type	Description
success	boolean	Whether the automations were successfully retrieved
output	object	Automations data
↳ automations	json	Array of automation objects
↳ total_items	number	Total number of automations
↳ total_returned	number	Number of automations returned in this response

Get Automation from Mailchimp

Retrieve details of a specific automation from Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
workflowId	string	Yes	The unique ID for the automation workflow (e.g., "abc123def4")

Output

Parameter	Type	Description
success	boolean	Whether the automation was successfully retrieved
output	object	Automation data
↳ automation	json	Automation object
↳ workflow_id	string	The unique ID of the automation workflow

Start Automation in Mailchimp

Start all emails in a Mailchimp automation workflow

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
workflowId	string	Yes	The unique ID for the automation workflow (e.g., "abc123def4")

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Start confirmation
↳ success	boolean	Operation success

Pause Automation in Mailchimp

Pause all emails in a Mailchimp automation workflow

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
workflowId	string	Yes	The unique ID for the automation workflow (e.g., "abc123def4")

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Pause confirmation
↳ success	boolean	Operation success

Add Subscriber to Automation in Mailchimp

Manually add a subscriber to a workflow email queue

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
workflowId	string	Yes	The unique ID for the automation workflow (e.g., "abc123def4")
workflowEmailId	string	Yes	The unique ID for the workflow email (e.g., "xyz789")
emailAddress	string	Yes	Email address of the subscriber (e.g., "user@example.com")

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Subscriber queue data
↳ subscriber	json	Subscriber object
↳ success	boolean	Operation success

Get Templates from Mailchimp

Retrieve a list of templates from Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
count	string	No	Number of results to return (default: 10, max: 1000)
offset	string	No	Number of results to skip for pagination

Output

Parameter	Type	Description
success	boolean	Whether the templates were successfully retrieved
output	object	Templates data
↳ templates	json	Array of template objects
↳ total_items	number	Total number of templates
↳ total_returned	number	Number of templates returned in this response

Get Template from Mailchimp

Retrieve details of a specific template from Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
templateId	string	Yes	The unique ID for the template (e.g., "12345")

Output

Parameter	Type	Description
success	boolean	Whether the template was successfully retrieved
output	object	Template data
↳ template	json	Template object
↳ template_id	string	The unique ID of the template

Create Template in Mailchimp

Create a new template in Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
templateName	string	Yes	The name of the template (e.g., "Monthly Newsletter")
templateHtml	string	Yes	The HTML content for the template

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Created template data
↳ template	json	Created template object
↳ template_id	string	Created template ID
↳ success	boolean	Operation success

Update Template in Mailchimp

Update an existing template in Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
templateId	string	Yes	The unique ID for the template (e.g., "12345")
templateName	string	No	The name of the template (e.g., "Monthly Newsletter")
templateHtml	string	No	The HTML content for the template

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Updated template data
↳ template	object	Updated template object
↳ template_id	string	Template ID
↳ success	boolean	Operation success

Delete Template from Mailchimp

Delete a template from Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
templateId	string	Yes	The unique ID for the template to delete (e.g., "12345")

Output

Parameter	Type	Description
success	boolean	Whether the template was successfully deleted

Get Campaign Reports from Mailchimp

Retrieve a list of campaign reports from Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
count	string	No	Number of results to return (default: 10, max: 1000)
offset	string	No	Number of results to skip for pagination

Output

Parameter	Type	Description
success	boolean	Whether the campaign reports were successfully retrieved
output	object	Campaign reports data
↳ reports	json	Array of campaign report objects
↳ total_items	number	Total number of reports
↳ total_returned	number	Number of reports returned in this response

Get Campaign Report from Mailchimp

Retrieve the report for a specific campaign from Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
campaignId	string	Yes	The unique ID for the campaign (e.g., "abc123def4")

Output

Parameter	Type	Description
success	boolean	Whether the campaign report was successfully retrieved
output	object	Campaign report data
↳ report	json	Campaign report object
↳ campaign_id	string	The unique ID of the campaign

Get Segments from Mailchimp Audience

Retrieve a list of segments from a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
count	string	No	Number of results to return (default: 10, max: 1000)
offset	string	No	Number of results to skip for pagination

Output

Parameter	Type	Description
success	boolean	Whether the segments were successfully retrieved
output	object	Segments data
↳ segments	json	Array of segment objects
↳ total_items	number	Total number of segments
↳ total_returned	number	Number of segments returned in this response

Get Segment from Mailchimp Audience

Retrieve details of a specific segment from a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
segmentId	string	Yes	The unique ID for the segment (e.g., "12345")

Output

Parameter	Type	Description
success	boolean	Whether the segment was successfully retrieved
output	object	Segment data
↳ segment	json	Segment object
↳ segment_id	string	The unique ID of the segment

Create Segment in Mailchimp Audience

Create a new segment in a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
segmentName	string	Yes	The name of the segment (e.g., "VIP Customers")
segmentOptions	string	No	JSON object of segment options for saved segments (e.g., {"match": "all", "conditions": [...]})

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Created segment data
↳ segment	json	Created segment object
↳ segment_id	string	Created segment ID
↳ success	boolean	Operation success

Update Segment in Mailchimp Audience

Update an existing segment in a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
segmentId	string	Yes	The unique ID for the segment (e.g., "12345")
segmentName	string	No	The name of the segment (e.g., "VIP Customers")
segmentOptions	string	No	JSON object of segment options (e.g., {"match": "all", "conditions": [...]})

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Updated segment data
↳ segment	object	Updated segment object
↳ segment_id	string	Segment ID
↳ success	boolean	Operation success

Delete Segment from Mailchimp Audience

Delete a segment from a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
segmentId	string	Yes	The unique ID for the segment to delete (e.g., "12345")

Output

Parameter	Type	Description
success	boolean	Whether the segment was successfully deleted

Get Segment Members from Mailchimp

Retrieve members of a specific segment from a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
segmentId	string	Yes	The unique ID for the segment (e.g., "12345")
count	string	No	Number of results to return (default: 10, max: 1000)
offset	string	No	Number of results to skip for pagination

Output

Parameter	Type	Description
success	boolean	Whether the segment members were successfully retrieved
output	object	Segment members data
↳ members	json	Array of member objects
↳ total_items	number	Total number of members
↳ total_returned	number	Number of members returned in this response

Add Member to Segment in Mailchimp

Add a member to a specific segment in a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
segmentId	string	Yes	The unique ID for the segment (e.g., "12345")
emailAddress	string	Yes	Email address of the member (e.g., "user@example.com")

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Added member data
↳ member	json	Added member object
↳ success	boolean	Operation success

Remove Member from Segment in Mailchimp

Remove a member from a specific segment in a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
segmentId	string	Yes	The unique ID for the segment (e.g., "12345")
subscriberEmail	string	Yes	Member email address or MD5 hash of the lowercase email

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Removal confirmation
↳ success	boolean	Operation success

Get Member Tags from Mailchimp

Retrieve tags associated with a member in a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
subscriberEmail	string	Yes	Member email address or MD5 hash of the lowercase email

Output

Parameter	Type	Description
success	boolean	Whether the member tags were successfully retrieved
output	object	Member tags data
↳ tags	json	Array of tag objects
↳ total_items	number	Total number of tags
↳ total_returned	number	Number of tags returned in this response

Add Tags to Member in Mailchimp

Add tags to a member in a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
subscriberEmail	string	Yes	Member email address or MD5 hash of the lowercase email
tags	string	Yes	JSON array of tag objects (e.g., [{"name": "VIP", "status": "active"}])

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Tag addition confirmation
↳ success	boolean	Operation success

Remove Tags from Member in Mailchimp

Remove tags from a member in a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
subscriberEmail	string	Yes	Member email address or MD5 hash of the lowercase email
tags	string	Yes	JSON array of tag objects with inactive status (e.g., [{"name": "VIP", "status": "inactive"}])

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Tag removal confirmation
↳ success	boolean	Operation success

Get Merge Fields from Mailchimp Audience

Retrieve a list of merge fields from a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
count	string	No	Number of results to return (default: 10, max: 1000)
offset	string	No	Number of results to skip for pagination

Output

Parameter	Type	Description
success	boolean	Whether the merge fields were successfully retrieved
output	object	Merge fields data
↳ mergeFields	json	Array of merge field objects
↳ total_items	number	Total number of merge fields
↳ total_returned	number	Number of merge fields returned in this response

Get Merge Field from Mailchimp Audience

Retrieve details of a specific merge field from a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
mergeId	string	Yes	The unique ID for the merge field (e.g., "1" or "FNAME")

Output

Parameter	Type	Description
success	boolean	Whether the merge field was successfully retrieved
output	object	Merge field data
↳ mergeField	json	Merge field object
↳ merge_id	string	The unique ID of the merge field

Create Merge Field in Mailchimp Audience

Create a new merge field in a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
mergeName	string	Yes	The name of the merge field (e.g., "First Name")
mergeType	string	Yes	The type of the merge field: "text", "number", "address", "phone", "date", "url", "imageurl", "radio", "dropdown", "birthday", or "zip"

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Created merge field data
↳ mergeField	json	Created merge field object
↳ merge_id	string	Created merge field ID
↳ success	boolean	Operation success

Update Merge Field in Mailchimp Audience

Update an existing merge field in a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
mergeId	string	Yes	The unique ID for the merge field (e.g., "1" or "FNAME")
mergeName	string	No	The name of the merge field (e.g., "First Name")

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Updated merge field data
↳ mergeField	object	Updated merge field object
↳ merge_id	string	Merge field ID
↳ success	boolean	Operation success

Delete Merge Field from Mailchimp Audience

Delete a merge field from a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
mergeId	string	Yes	The unique ID for the merge field to delete (e.g., "1" or "FNAME")

Output

Parameter	Type	Description
success	boolean	Whether the merge field was successfully deleted

Get Interest Categories from Mailchimp Audience

Retrieve a list of interest categories from a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
count	string	No	Number of results to return (default: 10, max: 1000)
offset	string	No	Number of results to skip for pagination

Output

Parameter	Type	Description
success	boolean	Whether the interest categories were successfully retrieved
output	object	Interest categories data
↳ categories	json	Array of interest category objects
↳ total_items	number	Total number of categories
↳ total_returned	number	Number of categories returned in this response

Get Interest Category from Mailchimp Audience

Retrieve details of a specific interest category from a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
interestCategoryId	string	Yes	The unique ID for the interest category (e.g., "xyz789")

Output

Parameter	Type	Description
success	boolean	Whether the interest category was successfully retrieved
output	object	Interest category data
↳ category	json	Interest category object
↳ interest_category_id	string	The unique ID of the interest category

Create Interest Category in Mailchimp Audience

Create a new interest category in a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
interestCategoryTitle	string	Yes	The title of the interest category (e.g., "Email Preferences")
interestCategoryType	string	Yes	The type of interest category: "checkboxes", "dropdown", "radio", or "hidden"

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Created interest category data
↳ category	json	Created interest category object
↳ interest_category_id	string	Created interest category ID
↳ success	boolean	Operation success

Update Interest Category in Mailchimp Audience

Update an existing interest category in a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
interestCategoryId	string	Yes	The unique ID for the interest category (e.g., "xyz789")
interestCategoryTitle	string	No	The title of the interest category (e.g., "Email Preferences")

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Updated interest category data
↳ category	object	Updated interest category object
↳ interest_category_id	string	Interest category ID
↳ success	boolean	Operation success

Delete Interest Category from Mailchimp Audience

Delete an interest category from a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
interestCategoryId	string	Yes	The unique ID for the interest category to delete (e.g., "xyz789")

Output

Parameter	Type	Description
success	boolean	Whether 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

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
interestCategoryId	string	Yes	The unique ID for the interest category (e.g., "xyz789")
count	string	No	Number of results to return (default: 10, max: 1000)
offset	string	No	Number of results to skip for pagination

Output

Parameter	Type	Description
success	boolean	Whether the interests were successfully retrieved
output	object	Interests data
↳ interests	json	Array of interest objects
↳ total_items	number	Total number of interests
↳ total_returned	number	Number 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

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
interestCategoryId	string	Yes	The unique ID for the interest category (e.g., "xyz789")
interestId	string	Yes	The unique ID for the interest (e.g., "def456")

Output

Parameter	Type	Description
success	boolean	Whether the interest was successfully retrieved
output	object	Interest data
↳ interest	json	Interest object
↳ interest_id	string	The unique ID of the interest

Create Interest in Mailchimp Interest Category

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

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
interestCategoryId	string	Yes	The unique ID for the interest category (e.g., "xyz789")
interestName	string	Yes	The name of the interest (e.g., "Weekly Updates")

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Created interest data
↳ interest	json	Created interest object
↳ interest_id	string	Created interest ID
↳ success	boolean	Operation success

Update Interest in Mailchimp Interest Category

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

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
interestCategoryId	string	Yes	The unique ID for the interest category (e.g., "xyz789")
interestId	string	Yes	The unique ID for the interest (e.g., "def456")
interestName	string	No	The name of the interest (e.g., "Weekly Updates")

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Updated interest data
↳ interest	object	Updated interest object
↳ interest_id	string	Interest ID
↳ success	boolean	Operation success

Delete Interest from Mailchimp Interest Category

Delete an interest from an interest category in a Mailchimp audience

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
listId	string	Yes	The unique ID for the audience/list (e.g., "abc123def4")
interestCategoryId	string	Yes	The unique ID for the interest category (e.g., "xyz789")
interestId	string	Yes	The unique ID for the interest to delete (e.g., "def456")

Output

Parameter	Type	Description
success	boolean	Whether the interest was successfully deleted

Get Landing Pages from Mailchimp

Retrieve a list of landing pages from Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
count	string	No	Number of results to return (default: 10, max: 1000)
offset	string	No	Number of results to skip for pagination

Output

Parameter	Type	Description
success	boolean	Whether the landing pages were successfully retrieved
output	object	Landing pages data
↳ landingPages	json	Array of landing page objects
↳ total_items	number	Total number of landing pages
↳ total_returned	number	Number of landing pages returned in this response

Get Landing Page from Mailchimp

Retrieve details of a specific landing page from Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
pageId	string	Yes	The unique ID for the landing page (e.g., "abc123def4")

Output

Parameter	Type	Description
success	boolean	Whether the landing page was successfully retrieved
output	object	Landing page data
↳ landingPage	json	Landing page object
↳ page_id	string	The unique ID of the landing page

Create Landing Page in Mailchimp

Create a new landing page in Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
landingPageType	string	Yes	The type of landing page: "signup"
landingPageTitle	string	No	The title of the landing page (e.g., "Join Our Newsletter")

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Created landing page data
↳ landingPage	json	Created landing page object
↳ page_id	string	Created landing page ID
↳ success	boolean	Operation success

Update Landing Page in Mailchimp

Update an existing landing page in Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
pageId	string	Yes	The unique ID for the landing page (e.g., "abc123def4")
landingPageTitle	string	No	The title of the landing page (e.g., "Join Our Newsletter")

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Updated landing page data
↳ landingPage	object	Updated landing page object
↳ page_id	string	Landing page ID
↳ success	boolean	Operation success

Delete Landing Page from Mailchimp

Delete a landing page from Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
pageId	string	Yes	The unique ID for the landing page to delete (e.g., "abc123def4")

Output

Parameter	Type	Description
success	boolean	Whether the landing page was successfully deleted

Publish Landing Page in Mailchimp

Publish a landing page in Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
pageId	string	Yes	The unique ID for the landing page (e.g., "abc123def4")

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Publish confirmation
↳ success	boolean	Operation success

Unpublish Landing Page in Mailchimp

Unpublish a landing page in Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
pageId	string	Yes	The unique ID for the landing page (e.g., "abc123def4")

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Unpublish confirmation
↳ success	boolean	Operation success

Get Batch Operations from Mailchimp

Retrieve a list of batch operations from Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
count	string	No	Number of results to return (default: 10, max: 1000)
offset	string	No	Number of results to skip for pagination

Output

Parameter	Type	Description
success	boolean	Whether the batch operations were successfully retrieved
output	object	Batch operations data
↳ batches	json	Array of batch operation objects
↳ total_items	number	Total number of batch operations
↳ total_returned	number	Number of batch operations returned in this response

Get Batch Operation from Mailchimp

Retrieve details of a specific batch operation from Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
batchId	string	Yes	The unique ID for the batch operation (e.g., "abc123def4")

Output

Parameter	Type	Description
success	boolean	Whether the batch operation was successfully retrieved
output	object	Batch operation data
↳ batch	json	Batch operation object
↳ batch_id	string	The unique ID of the batch operation

Create Batch Operation in Mailchimp

Create a new batch operation in Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
operations	string	Yes	JSON array of batch operations (e.g., [{"method": "POST", "path": "/lists/{list_id}/members", "body": "..."}])

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Created batch operation data
↳ batch	json	Created batch operation object
↳ batch_id	string	Created batch operation ID
↳ success	boolean	Operation success

Delete Batch Operation from Mailchimp

Delete a batch operation from Mailchimp

Inputs and outputs

Input

Parameter	Type	Required	Description
apiKey	string	Yes	Mailchimp API key with server prefix
batchId	string	Yes	The unique ID for the batch operation to delete (e.g., "abc123def4")

Output

Parameter	Type	Description
success	boolean	Whether the batch operation was successfully deleted