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.
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.
Retrieve a list of audiences (lists) from Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Audiences data and metadata |
Retrieve details of a specific audience (list) from Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Audience data and metadata |
Create a new audience (list) in Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
audienceName | string | Yes | The name of the list |
contact | string | Yes | JSON object of contact information |
permissionReminder | string | Yes | Permission reminder text |
campaignDefaults | string | Yes | JSON object of default campaign settings |
emailTypeOption | string | Yes | Support multiple email formats |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Created audience data |
Update an existing audience (list) in Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
audienceName | string | No | The name of the list |
permissionReminder | string | No | Permission reminder text |
campaignDefaults | string | No | JSON object of default campaign settings |
emailTypeOption | string | No | Support multiple email formats |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Updated audience data |
Delete an audience (list) from Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list to delete |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Deletion confirmation |
Retrieve a list of members from a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
status | string | No | Filter by status (subscribed, unsubscribed, cleaned, pending) |
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Members data and metadata |
Retrieve details of a specific member from a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
subscriberEmail | string | Yes | Member email address or MD5 hash |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Member data and metadata |
Add a new member to a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
emailAddress | string | Yes | Member email address |
status | string | Yes | Subscriber status |
mergeFields | string | No | JSON object of merge fields |
interests | string | No | JSON object of interests |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Added member data |
Add a new member or update an existing member in a Mailchimp audience (upsert)
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
subscriberEmail | string | Yes | Member email address or MD5 hash |
emailAddress | string | Yes | Member email address |
statusIfNew | string | Yes | Subscriber status if new member |
mergeFields | string | No | JSON object of merge fields |
interests | string | No | JSON object of interests |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Member data |
Update an existing member in a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
subscriberEmail | string | Yes | Member email address or MD5 hash |
emailAddress | string | No | Member email address |
status | string | No | Subscriber status |
mergeFields | string | No | JSON object of merge fields |
interests | string | No | JSON object of interests |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Updated member data |
Delete a member from a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
subscriberEmail | string | Yes | Member email address or MD5 hash |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Deletion confirmation |
Permanently archive (delete) a member from a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
subscriberEmail | string | Yes | Member email address or MD5 hash |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Archive confirmation |
Restore an archived member to a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
subscriberEmail | string | Yes | Member email address or MD5 hash |
emailAddress | string | Yes | Member email address |
status | string | Yes | Subscriber status |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Unarchived member data |
Retrieve a list of campaigns from Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
campaignType | string | No | Filter by campaign type (regular, plaintext, absplit, rss, variate) |
status | string | No | Filter by status (save, paused, schedule, sending, sent) |
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Campaigns data and metadata |
Retrieve details of a specific campaign from Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
campaignId | string | Yes | The unique ID for the campaign |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Campaign data and metadata |
Create a new campaign in Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
campaignType | string | Yes | Campaign type |
campaignSettings | string | Yes | JSON object of campaign settings |
recipients | string | No | JSON object of recipients |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Created campaign data |
Update an existing campaign in Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
campaignId | string | Yes | The unique ID for the campaign |
campaignSettings | string | No | JSON object of campaign settings |
recipients | string | No | JSON object of recipients |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Updated campaign data |
Delete a campaign from Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
campaignId | string | Yes | The unique ID for the campaign to delete |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Deletion confirmation |
Send a Mailchimp campaign
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
campaignId | string | Yes | The unique ID for the campaign to send |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Send confirmation |
Schedule a Mailchimp campaign to be sent at a specific time
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
campaignId | string | Yes | The unique ID for the campaign to schedule |
scheduleTime | string | Yes | ISO 8601 format date and time |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Schedule confirmation |
Unschedule a previously scheduled Mailchimp campaign
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
campaignId | string | Yes | The unique ID for the campaign to unschedule |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Unschedule confirmation |
Create a copy of an existing Mailchimp campaign
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
campaignId | string | Yes | The unique ID for the campaign to replicate |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Replicated campaign data |
Retrieve the HTML and plain-text content for a Mailchimp campaign
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
campaignId | string | Yes | The unique ID for the campaign |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Campaign content data |
Set the content for a Mailchimp campaign
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
campaignId | string | Yes | The unique ID for the campaign |
html | string | No | The HTML content for the campaign |
plainText | string | No | The plain-text content for the campaign |
templateId | string | No | The ID of the template to use |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Campaign content data |
Retrieve a list of automations from Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Automations data and metadata |
Retrieve details of a specific automation from Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
workflowId | string | Yes | The unique ID for the automation workflow |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Automation data and metadata |
Start all emails in a Mailchimp automation workflow
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
workflowId | string | Yes | The unique ID for the automation workflow |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Start confirmation |
Pause all emails in a Mailchimp automation workflow
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
workflowId | string | Yes | The unique ID for the automation workflow |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Pause confirmation |
Manually add a subscriber to a workflow email queue
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
workflowId | string | Yes | The unique ID for the automation workflow |
workflowEmailId | string | Yes | The unique ID for the workflow email |
emailAddress | string | Yes | Email address of the subscriber |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Subscriber queue data |
Retrieve a list of templates from Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Templates data and metadata |
Retrieve details of a specific template from Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
templateId | string | Yes | The unique ID for the template |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Template data and metadata |
Create a new template in Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
templateName | string | Yes | The name of the template |
templateHtml | string | Yes | The HTML content for the template |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Created template data |
Update an existing template in Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
templateId | string | Yes | The unique ID for the template |
templateName | string | No | The name of the template |
templateHtml | string | No | The HTML content for the template |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Updated template data |
Delete a template from Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
templateId | string | Yes | The unique ID for the template to delete |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Deletion confirmation |
Retrieve a list of campaign reports from Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Campaign reports data and metadata |
Retrieve the report for a specific campaign from Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
campaignId | string | Yes | The unique ID for the campaign |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Campaign report data and metadata |
Retrieve a list of segments from a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Segments data and metadata |
Retrieve details of a specific segment from a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
segmentId | string | Yes | The unique ID for the segment |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Segment data and metadata |
Create a new segment in a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
segmentName | string | Yes | The name of the segment |
segmentOptions | string | No | JSON object of segment options |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Created segment data |
Update an existing segment in a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
segmentId | string | Yes | The unique ID for the segment |
segmentName | string | No | The name of the segment |
segmentOptions | string | No | JSON object of segment options |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Updated segment data |
Delete a segment from a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
segmentId | string | Yes | The unique ID for the segment to delete |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Deletion confirmation |
Retrieve members of a specific segment from a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
segmentId | string | Yes | The unique ID for the segment |
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Segment members data and metadata |
Add a member to a specific segment in a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
segmentId | string | Yes | The unique ID for the segment |
emailAddress | string | Yes | Email address of the member |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Added member data |
Remove a member from a specific segment in a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
segmentId | string | Yes | The unique ID for the segment |
subscriberEmail | string | Yes | Member email address or MD5 hash |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Removal confirmation |
Retrieve tags associated with a member in a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
subscriberEmail | string | Yes | Member email address or MD5 hash |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Member tags data and metadata |
Add tags to a member in a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
subscriberEmail | string | Yes | Member email address or MD5 hash |
tags | string | Yes | JSON array of tags |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Tag addition confirmation |
Remove tags from a member in a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
subscriberEmail | string | Yes | Member email address or MD5 hash |
tags | string | Yes | JSON array of tags with inactive status |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Tag removal confirmation |
Retrieve a list of merge fields from a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Merge fields data and metadata |
Retrieve details of a specific merge field from a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
mergeId | string | Yes | The unique ID for the merge field |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Merge field data and metadata |
Create a new merge field in a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
mergeName | string | Yes | The name of the merge field |
mergeType | string | Yes | The type of the merge field (text, number, address, phone, date, url, imageurl, radio, dropdown, birthday, zip) |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Created merge field data |
Update an existing merge field in a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
mergeId | string | Yes | The unique ID for the merge field |
mergeName | string | No | The name of the merge field |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Updated merge field data |
Delete a merge field from a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
mergeId | string | Yes | The unique ID for the merge field to delete |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Deletion confirmation |
Retrieve a list of interest categories from a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Interest categories data and metadata |
Retrieve details of a specific interest category from a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
interestCategoryId | string | Yes | The unique ID for the interest category |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Interest category data and metadata |
Create a new interest category in a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
interestCategoryTitle | string | Yes | The title of the interest category |
interestCategoryType | string | Yes | The type of interest category (checkboxes, dropdown, radio, hidden) |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Created interest category data |
Update an existing interest category in a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
interestCategoryId | string | Yes | The unique ID for the interest category |
interestCategoryTitle | string | No | The title of the interest category |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Updated interest category data |
Delete an interest category from a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
interestCategoryId | string | Yes | The unique ID for the interest category to delete |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Deletion confirmation |
Retrieve a list of interests from an interest category in a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
interestCategoryId | string | Yes | The unique ID for the interest category |
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Interests data and metadata |
Retrieve details of a specific interest from an interest category in a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
interestCategoryId | string | Yes | The unique ID for the interest category |
interestId | string | Yes | The unique ID for the interest |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Interest data and metadata |
Create a new interest in an interest category in a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
interestCategoryId | string | Yes | The unique ID for the interest category |
interestName | string | Yes | The name of the interest |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Created interest data |
Update an existing interest in an interest category in a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
interestCategoryId | string | Yes | The unique ID for the interest category |
interestId | string | Yes | The unique ID for the interest |
interestName | string | No | The name of the interest |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Updated interest data |
Delete an interest from an interest category in a Mailchimp audience
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
listId | string | Yes | The unique ID for the list |
interestCategoryId | string | Yes | The unique ID for the interest category |
interestId | string | Yes | The unique ID for the interest to delete |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Deletion confirmation |
Retrieve a list of landing pages from Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Landing pages data and metadata |
Retrieve details of a specific landing page from Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
pageId | string | Yes | The unique ID for the landing page |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Landing page data and metadata |
Create a new landing page in Mailchimp
| 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 |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Created landing page data |
Update an existing landing page in Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
pageId | string | Yes | The unique ID for the landing page |
landingPageTitle | string | No | The title of the landing page |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Updated landing page data |
Delete a landing page from Mailchimp
| 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 |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Deletion confirmation |
Publish a landing page in Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
pageId | string | Yes | The unique ID for the landing page |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Publish confirmation |
Unpublish a landing page in Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
pageId | string | Yes | The unique ID for the landing page |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Unpublish confirmation |
Retrieve a list of batch operations from Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
count | string | No | Number of results (default: 10, max: 1000) |
offset | string | No | Number of results to skip |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Batch operations data and metadata |
Retrieve details of a specific batch operation from Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
batchId | string | Yes | The unique ID for the batch operation |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Batch operation data and metadata |
Create a new batch operation in Mailchimp
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Mailchimp API key with server prefix |
operations | string | Yes | JSON array of operations |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Created batch operation data |
Delete a batch operation from Mailchimp
| 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 |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Deletion confirmation |
- Category:
tools
- Type:
mailchimp