Marketing API
API Root
The API root resource links to all other resources available in the API. Calling the root directory also returns details about the Mailchimp user account.
List api root resources
get
/
Get links to all other resources available in the API.
Authorized Apps
Manage registered, connected apps for your Mailchimp account with the Authorized Apps endpoints.
List authorized apps
get
/authorized-apps
Get a list of an account's registered, connected applications.
Get authorized app info
get
/authorized-apps/{app_id}
Get information about a specific authorized application.
Automations
Mailchimp's classic automations feature lets you build a series of emails that send to subscribers when triggered by a specific date, activity, or event. Use the API to manage Automation workflows, emails, and queues. Does not include Customer Journeys.
List automations
get
/automations
Get a summary of an account's classic automations.
Add automation
post
/automations
Create a new classic automation in your Mailchimp account.
Get automation info
get
/automations/{workflow_id}
Get a summary of an individual classic automation workflow's settings and content. The
trigger_settingsobject returns information for the first email in the workflow.Start automation emails
post
/automations/{workflow_id}/actions/start-all-emails
Start all emails in a classic automation workflow.
Pause automation emails
post
/automations/{workflow_id}/actions/pause-all-emails
Pause all emails in a specific classic automation workflow.
Archive automation
post
/automations/{workflow_id}/actions/archive
Archiving will permanently end your automation and keep the report data. You’ll be able to replicate your archived automation, but you can’t restart it.
Automations
Emails
Manage individual emails in a classic automation workflow.
List automated emails
get
/automations/{workflow_id}/emails
Get a summary of the emails in a classic automation workflow.
Get workflow email info
get
/automations/{workflow_id}/emails/{workflow_email_id}
Get information about an individual classic automation workflow email.
Delete workflow email
delete
/automations/{workflow_id}/emails/{workflow_email_id}
Removes an individual classic automation workflow email. Emails from certain workflow types, including the Abandoned Cart Email (abandonedCart) and Product Retargeting Email (abandonedBrowse) Workflows, cannot be deleted.
Update workflow email
patch
/automations/{workflow_id}/emails/{workflow_email_id}
Update settings for a classic automation workflow email
Pause automated email
post
/automations/{workflow_id}/emails/{workflow_email_id}/actions/pause
Pause an automated email.
Start automated email
post
/automations/{workflow_id}/emails/{workflow_email_id}/actions/start
Start an automated email.
Automations
Queue
Manage list member queues for classic automation emails.
List automated email subscribers
get
/automations/{workflow_id}/emails/{workflow_email_id}/queue
Get information about a classic automation email queue.
Add subscriber to workflow email
post
/automations/{workflow_id}/emails/{workflow_email_id}/queue
Manually add a subscriber to a workflow, bypassing the default trigger settings. You can also use this endpoint to trigger a series of automated emails in an API 3.0 workflow type.
Get automated email subscriber
get
/automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}
Get information about a specific subscriber in a classic automation email queue.
Automations
Removed Subscribers
Remove subscribers from a classic automation workflow.
List subscribers removed from workflow
get
/automations/{workflow_id}/removed-subscribers
Get information about subscribers who were removed from a classic automation workflow.
Remove subscriber from workflow
post
/automations/{workflow_id}/removed-subscribers
Remove a subscriber from a specific classic automation workflow. You can remove a subscriber at any point in an automation workflow, regardless of how many emails they've been sent from that workflow. Once they're removed, they can never be added back to the same workflow.
Get subscriber removed from workflow
get
/automations/{workflow_id}/removed-subscribers/{subscriber_hash}
Get information about a specific subscriber who was removed from a classic automation workflow.
Batch Operations
Use batch operations to complete multiple operations with a single call.
List batch requests
get
/batches
Get a summary of batch requests that have been made.
Start batch operation
post
/batches
Begin processing a batch operations request.
Get batch operation status
get
/batches/{batch_id}
Get the status of a batch request.
Delete batch request
delete
/batches/{batch_id}
Stops a batch request from running. Since only one batch request is run at a time, this can be used to cancel a long running request. The results of any completed operations will not be available after this call.
Batch Webhooks
Manage webhooks for batch operations.
List batch webhooks
get
/batch-webhooks
Get all webhooks that have been configured for batches.
Add batch webhook
post
/batch-webhooks
Configure a webhook that will fire whenever any batch request completes processing.
Get batch webhook info
get
/batch-webhooks/{batch_webhook_id}
Get information about a specific batch webhook.
Update batch webhook
patch
/batch-webhooks/{batch_webhook_id}
Update a webhook that will fire whenever any batch request completes processing.
Delete batch webhook
delete
/batch-webhooks/{batch_webhook_id}
Remove a batch webhook. Webhooks will no longer be sent to the given URL.
Campaign Folders
Organize your campaigns using folders.
List campaign folders
get
/campaign-folders
Get all folders used to organize campaigns.
Add campaign folder
post
/campaign-folders
Create a new campaign folder.
Get campaign folder
get
/campaign-folders/{folder_id}
Get information about a specific folder used to organize campaigns.
Update campaign folder
patch
/campaign-folders/{folder_id}
Update a specific folder used to organize campaigns.
Delete campaign folder
delete
/campaign-folders/{folder_id}
Delete a specific campaign folder, and mark all the campaigns in the folder as 'unfiled'.
Campaigns
Campaigns are how you send emails to your Mailchimp list. Use the Campaigns API calls to manage campaigns in your Mailchimp account.
List campaigns
get
/campaigns
Get all campaigns in an account.
Add campaign
post
/campaigns
Create a new Mailchimp campaign.
Get campaign info
get
/campaigns/{campaign_id}
Get information about a specific campaign.
Update campaign settings
patch
/campaigns/{campaign_id}
Update some or all of the settings for a specific campaign.
Delete campaign
delete
/campaigns/{campaign_id}
Remove a campaign from your Mailchimp account.
Cancel campaign
post
/campaigns/{campaign_id}/actions/cancel-send
Cancel a Regular or Plain-Text Campaign after you send, before all of your recipients receive it. This feature is included with Mailchimp Pro.
Send campaign
post
/campaigns/{campaign_id}/actions/send
Send a Mailchimp campaign. For RSS Campaigns, the campaign will send according to its schedule. All other campaigns will send immediately.
Schedule campaign
post
/campaigns/{campaign_id}/actions/schedule
Schedule a campaign for delivery. If you're using Multivariate Campaigns to test send times or sending RSS Campaigns, use the send action instead.
Unschedule campaign
post
/campaigns/{campaign_id}/actions/unschedule
Unschedule a scheduled campaign that hasn't started sending.
Pause rss campaign
post
/campaigns/{campaign_id}/actions/pause
Pause an RSS-Driven campaign.
Resume rss campaign
post
/campaigns/{campaign_id}/actions/resume
Resume an RSS-Driven campaign.
Replicate campaign
post
/campaigns/{campaign_id}/actions/replicate
Replicate a campaign in saved or send status.
Send test email
post
/campaigns/{campaign_id}/actions/test
Send a test email.
Resend campaign
post
/campaigns/{campaign_id}/actions/create-resend
Creates a Resend to Non-Openers version of this campaign. We will also check if this campaign meets the criteria for Resend to Non-Openers campaigns.
Campaigns
Content
Manage the HTML, plain-text, and template content for your Mailchimp campaigns.
Get campaign content
get
/campaigns/{campaign_id}/content
Get the the HTML and plain-text content for a campaign.
Set campaign content
put
/campaigns/{campaign_id}/content
Set the content for a campaign.
Campaigns
Feedback
Post comments, reply to team feedback, and send test emails while you're working together on a Mailchimp campaign.
List campaign feedback
get
/campaigns/{campaign_id}/feedback
Get team feedback while you're working together on a Mailchimp campaign.
Add campaign feedback
post
/campaigns/{campaign_id}/feedback
Add feedback on a specific campaign.
Get campaign feedback message
get
/campaigns/{campaign_id}/feedback/{feedback_id}
Get a specific feedback message from a campaign.
Update campaign feedback message
patch
/campaigns/{campaign_id}/feedback/{feedback_id}
Update a specific feedback message for a campaign.
Delete campaign feedback message
delete
/campaigns/{campaign_id}/feedback/{feedback_id}
Remove a specific feedback message for a campaign.
Campaigns
Send Checklist
Review the send checklist for your campaign, and resolve any issues before sending.
Get campaign send checklist
get
/campaigns/{campaign_id}/send-checklist
Review the send checklist for a campaign, and resolve any issues before sending.
Chimp Chatter Activity
Get the latest Chimp Chatter activity from your account.
Get latest chimp chatter
get
/activity-feed/chimp-chatter
Return the Chimp Chatter for this account ordered by most recent.
Connected Sites
Manage sites you've connected to your Mailchimp account.
List connected sites
get
/connected-sites
Get all connected sites in an account.
Add connected site
post
/connected-sites
Create a new Mailchimp connected site.
Get connected site
get
/connected-sites/{connected_site_id}
Get information about a specific connected site.
Delete connected site
delete
/connected-sites/{connected_site_id}
Remove a connected site from your Mailchimp account.
Verify connected site script
post
/connected-sites/{connected_site_id}/actions/verify-script-installation
Verify that the connected sites script has been installed, either via the script URL or fragment.
Conversations
Conversation tracking lets you view subscribers' replies to your campaigns in your Mailchimp account.
List conversations
get
/conversations
Get a list of conversations for the account.
Get conversation
get
/conversations/{conversation_id}
Get details about an individual conversation.
Conversations
Messages
Manage messages in a specific campaign conversation.
List messages
get
/conversations/{conversation_id}/messages
Get messages from a specific conversation.
Get message
get
/conversations/{conversation_id}/messages/{message_id}
Get an individual message in a conversation.
Customer Journeys
Manage Customer Journey automated workflows
Customer Journeys API trigger for a contact
post
/customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger
A step trigger in a Customer Journey. To use it, create a starting point or step from the Customer Journey builder in the app using the Customer Journeys API condition. We’ll provide a url during the process that includes the {journey_id} and {step_id}. You’ll then be able to use this endpoint to trigger the condition for the posted contact.
E-commerce Stores
Connect your E-commerce Store to Mailchimp to take advantage of powerful reporting and personalization features and to learn more about your customers.
List stores
get
/ecommerce/stores
Get information about all stores in the account.
Add store
post
/ecommerce/stores
Add a new store to your Mailchimp account.
Get store info
get
/ecommerce/stores/{store_id}
Get information about a specific store.
Update store
patch
/ecommerce/stores/{store_id}
Update a store.
Delete store
delete
/ecommerce/stores/{store_id}
Delete a store. Deleting a store will also delete any associated subresources, including Customers, Orders, Products, and Carts.
E-commerce Stores
Cart Lines
Each Cart contains one or more Cart Lines, which represent a specific Product Variant that a Customer has added to their shopping cart.
List cart line items
get
/ecommerce/stores/{store_id}/carts/{cart_id}/lines
Get information about a cart's line items.
Add cart line item
post
/ecommerce/stores/{store_id}/carts/{cart_id}/lines
Add a new line item to an existing cart.
Get cart line item
get
/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}
Get information about a specific cart line item.
Update cart line item
patch
/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}
Update a specific cart line item.
Delete cart line item
delete
/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}
Delete a specific cart line item.
E-commerce Stores
Carts
Use Carts to represent unfinished e-commerce transactions. This can be used to create an Abandoned Cart workflow, or to save a consumer’s shopping cart pending a successful Order.
List carts
get
/ecommerce/stores/{store_id}/carts
Get information about a store's carts.
Add cart
post
/ecommerce/stores/{store_id}/carts
Add a new cart to a store.
Get cart info
get
/ecommerce/stores/{store_id}/carts/{cart_id}
Get information about a specific cart.
Update cart
patch
/ecommerce/stores/{store_id}/carts/{cart_id}
Update a specific cart.
Delete cart
delete
/ecommerce/stores/{store_id}/carts/{cart_id}
Delete a cart.
E-commerce Stores
Customers
Add Customers to your Store to track their orders and to view E-Commerce Data for your Mailchimp lists and campaigns. Each Customer is connected to a Mailchimp list member, so adding a Customer can also add or update a list member.
List customers
get
/ecommerce/stores/{store_id}/customers
Get information about a store's customers.
Add customer
post
/ecommerce/stores/{store_id}/customers
Add a new customer to a store.
Get customer info
get
/ecommerce/stores/{store_id}/customers/{customer_id}
Get information about a specific customer.
Add or update customer
put
/ecommerce/stores/{store_id}/customers/{customer_id}
Add or update a customer.
Update customer
patch
/ecommerce/stores/{store_id}/customers/{customer_id}
Update a customer.
Delete customer
delete
/ecommerce/stores/{store_id}/customers/{customer_id}
Delete a customer from a store.
E-commerce Stores
Order Lines
Each Order contains one or more Order Lines, which represent a specific Product Variant that a Customer purchases.
List order line items
get
/ecommerce/stores/{store_id}/orders/{order_id}/lines
Get information about an order's line items.
Add order line item
post
/ecommerce/stores/{store_id}/orders/{order_id}/lines
Add a new line item to an existing order.
Get order line item
get
/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}
Get information about a specific order line item.
Update order line item
patch
/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}
Update a specific order line item.
Delete order line item
delete
/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}
Delete a specific order line item.
E-commerce Stores
Orders
Orders represent successful e-commerce transactions, and this data can be used to provide more detailed campaign reports, track sales, and personalize emails to your targeted consumers, and view other e-commerce data in your Mailchimp account.
List account orders
get
/ecommerce/orders
Get information about an account's orders.
List orders
get
/ecommerce/stores/{store_id}/orders
Get information about a store's orders.
Add order
post
/ecommerce/stores/{store_id}/orders
Add a new order to a store.
Get order info
get
/ecommerce/stores/{store_id}/orders/{order_id}
Get information about a specific order.
Update order
patch
/ecommerce/stores/{store_id}/orders/{order_id}
Update a specific order.
Delete order
delete
/ecommerce/stores/{store_id}/orders/{order_id}
Delete an order.
E-commerce Stores
Product Images
A Product Image represents a specific product image.
List product images
get
/ecommerce/stores/{store_id}/products/{product_id}/images
Get information about a product's images.
Add product image
post
/ecommerce/stores/{store_id}/products/{product_id}/images
Add a new image to the product.
Get product image info
get
/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
Get information about a specific product image.
Update product image
patch
/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
Update a product image.
Delete product image
delete
/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
Delete a product image.
E-commerce Stores
Product Variants
A Product Variant represents a specific item for purchase, and is contained within a parent Product. At least one Product Variant is required for each Product.
List product variants
get
/ecommerce/stores/{store_id}/products/{product_id}/variants
Get information about a product's variants.
Add product variant
post
/ecommerce/stores/{store_id}/products/{product_id}/variants
Add a new variant to the product.
Get product variant info
get
/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
Get information about a specific product variant.
Add or update product variant
put
/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
Add or update a product variant.
Update product variant
patch
/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
Update a product variant.
Delete product variant
delete
/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
Delete a product variant.
E-commerce Stores
Products
E-commerce items for sale in your store need to be created as Products so you can add the items to a Cart or an Order. Each Product requires at least one Product Variant.
List product
get
/ecommerce/stores/{store_id}/products
Get information about a store's products.
Add product
post
/ecommerce/stores/{store_id}/products
Add a new product to a store.
Get product info
get
/ecommerce/stores/{store_id}/products/{product_id}
Get information about a specific product.
Update product
patch
/ecommerce/stores/{store_id}/products/{product_id}
Update a specific product.
Delete product
delete
/ecommerce/stores/{store_id}/products/{product_id}
Delete a product.
E-commerce Stores
Promo Codes
Promo codes can be created for a given price rule. All the promo codes under a price rule share the generic information defined for that rule like the amount, type, expiration date etc. Promo code defines the more specific information about a promo code like the actual code, redemption_url, usage_count, etc that's unique to a code. Promo Code must be defined under a promo rule.
List promo codes
get
/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes
Get information about a store's promo codes.
Add promo code
post
/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes
Add a new promo code to a store.
Get promo code
get
/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}
Get information about a specific promo code.
Update promo code
patch
/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}
Update a promo code.
Delete promo code
delete
/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}
Delete a promo code from a store.
E-commerce Stores
Promo Rules
Promo Rules help you create promo codes for your campaigns. Promo Rules define generic information about promo codes like expiration time, start time, amount of discount being offered etc. For a given promo rule you can define if it's a percentage discount or a fixed amount and if it applies for the order as a whole or if it's per item or free shipping. You can then create promo codes for this price rule. Promo codes contain the actual code that is applied at checkout along with some other information. Price Rules have one to many relationship with promo codes.
List promo rules
get
/ecommerce/stores/{store_id}/promo-rules
Get information about a store's promo rules.
Add promo rule
post
/ecommerce/stores/{store_id}/promo-rules
Add a new promo rule to a store.
Get promo rule
get
/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}
Get information about a specific promo rule.
Update promo rule
patch
/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}
Update a promo rule.
Delete promo rule
delete
/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}
Delete a promo rule from a store.
Facebook Ads
Get information about Facebook Ads.
List facebook ads
get
/facebook-ads
Get list of Facebook ads.
Get facebook ad info
get
/facebook-ads/{outreach_id}
Get details of a Facebook ad.
File Manager
Manage files for your Mailchimp account. The File Manager is a place to store images, documents, and other files you include or link to in your campaigns, templates, or signup forms.
File Manager
File Manager Files
Manage specific files in the File Manager for your Mailchimp account.
List stored files
get
/file-manager/files
Get a list of available images and files stored in the File Manager for the account.
Add file
post
/file-manager/files
Upload a new image or file to the File Manager.
Get file
get
/file-manager/files/{file_id}
Get information about a specific file in the File Manager.
Update file
patch
/file-manager/files/{file_id}
Update a file in the File Manager.
Delete file
delete
/file-manager/files/{file_id}
Remove a specific file from the File Manager.
File Manager
File Manager Folders
Manage specific folders in the File Manager for your Mailchimp account.
List folders
get
/file-manager/folders
Get a list of all folders in the File Manager.
Add folder
post
/file-manager/folders
Create a new folder in the File Manager.
Get folder
get
/file-manager/folders/{folder_id}
Get information about a specific folder in the File Manager.
Update folder
patch
/file-manager/folders/{folder_id}
Update a specific File Manager folder.
Delete folder
delete
/file-manager/folders/{folder_id}
Delete a specific folder in the File Manager.
Landing Pages
Manage your Landing Pages, including publishing and unpublishing.
List landing pages
get
/landing-pages
Get all landing pages.
Add landing page
post
/landing-pages
Create a new Mailchimp landing page.
Get landing page info
get
/landing-pages/{page_id}
Get information about a specific page.
Update landing page
patch
/landing-pages/{page_id}
Update a landing page.
Delete landing page
delete
/landing-pages/{page_id}
Delete a landing page.
Publish landing page
post
/landing-pages/{page_id}/actions/publish
Publish a landing page that is in draft, unpublished, or has been previously published and edited.
Unpublish landing page
post
/landing-pages/{page_id}/actions/unpublish
Unpublish a landing page that is in draft or has been published.
Landing Pages
Content
The HTML content for your Mailchimp landing pages.
Get landing page content
get
/landing-pages/{page_id}/content
Get the the HTML for your landing page.
Lists/Audiences
Your Mailchimp list, also known as your audience, is where you store and manage all of your contacts.
Get lists info
get
/lists
Get information about all lists in the account.
Add list
post
/lists
Create a new list in your Mailchimp account.
Get list info
get
/lists/{list_id}
Get information about a specific list in your Mailchimp account. Results include list members who have signed up but haven't confirmed their subscription yet and unsubscribed or cleaned.
Update lists
patch
/lists/{list_id}
Update the settings for a specific list.
Delete list
delete
/lists/{list_id}
Delete a list from your Mailchimp account. If you delete a list, you'll lose the list history—including subscriber activity, unsubscribes, complaints, and bounces. You’ll also lose subscribers’ email addresses, unless you exported and backed up your list.
Batch subscribe or unsubscribe
post
/lists/{list_id}
Batch subscribe or unsubscribe list members.
Lists/Audiences
Abuse Reports
Manage abuse complaints for a specific list. An abuse complaint occurs when your recipient reports an email as spam in their mail program.
List abuse reports
get
/lists/{list_id}/abuse-reports
Get all abuse reports for a specific list.
Get abuse report
get
/lists/{list_id}/abuse-reports/{report_id}
Get details about a specific abuse report.
Lists/Audiences
Activity
Get recent daily, aggregated activity stats for your list. For example, view unsubscribes, signups, total emails sent, opens, clicks, and more, for up to 180 days.
List recent activity
get
/lists/{list_id}/activity
Get up to the previous 180 days of daily detailed aggregated activity stats for a list, not including Automation activity.
Lists/Audiences
Clients
Get information about the most popular email clients for subscribers in a specific Mailchimp list.
List top email clients
get
/lists/{list_id}/clients
Get a list of the top email clients based on user-agent strings.
Lists/Audiences
Events
Use the Events endpoint to collect website or in-app actions and trigger targeted automations.
List member events
get
/lists/{list_id}/members/{subscriber_hash}/events
Get events for a contact.
Add event
post
/lists/{list_id}/members/{subscriber_hash}/events
Add an event for a list member.
Lists/Audiences
Growth History
View a summary of the month-by-month growth activity for a specific list.
List growth history data
get
/lists/{list_id}/growth-history
Get a month-by-month summary of a specific list's growth activity.
Get growth history by month
get
/lists/{list_id}/growth-history/{month}
Get a summary of a specific list's growth activity for a specific month and year.
Lists/Audiences
Interest Categories
Manage interest categories for a specific list. Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to 'group titles' in the Mailchimp application.
List interest categories
get
/lists/{list_id}/interest-categories
Get information about a list's interest categories.
Add interest category
post
/lists/{list_id}/interest-categories
Create a new interest category.
Get interest category info
get
/lists/{list_id}/interest-categories/{interest_category_id}
Get information about a specific interest category.
Update interest category
patch
/lists/{list_id}/interest-categories/{interest_category_id}
Update a specific interest category.
Delete interest category
delete
/lists/{list_id}/interest-categories/{interest_category_id}
Delete a specific interest category.
Lists/Audiences
Interests
Manage interests for a specific Mailchimp list. Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application.
List interests in category
get
/lists/{list_id}/interest-categories/{interest_category_id}/interests
Get a list of this category's interests.
Add interest in category
post
/lists/{list_id}/interest-categories/{interest_category_id}/interests
Create a new interest or 'group name' for a specific category.
Get interest in category
get
/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}
Get interests or 'group names' for a specific category.
Update interest in category
patch
/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}
Update interests or 'group names' for a specific category.
Delete interest in category
delete
/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}
Delete interests or group names in a specific category.
Lists/Audiences
Locations
Get the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address.
List locations
get
/lists/{list_id}/locations
Get the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address.
Lists/Audiences
Member Activity
Get details about a subscriber's recent activity. Use the new activity-feed endpoint to access more events for a given contact.
View recent activity 50
get
/lists/{list_id}/members/{subscriber_hash}/activity
Get the last 50 events of a member's activity on a specific list, including opens, clicks, and unsubscribes.
Lists/Audiences
Member Activity Feed
Get details about a subscriber's recent activity.
View recent activity
get
/lists/{list_id}/members/{subscriber_hash}/activity-feed
Get a member's activity on a specific list, including opens, clicks, and unsubscribes.
Lists/Audiences
Member Goals
Get information about recent goal events for a specific list member.
List member goal events
get
/lists/{list_id}/members/{subscriber_hash}/goals
Get the last 50 Goal events for a member on a specific list.
Lists/Audiences
Member Notes
Retrieve recent notes for a specific list member.
List recent member notes
get
/lists/{list_id}/members/{subscriber_hash}/notes
Get recent notes for a specific list member.
Add member note
post
/lists/{list_id}/members/{subscriber_hash}/notes
Add a new note for a specific subscriber.
Get member note
get
/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}
Get a specific note for a specific list member.
Update note
patch
/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}
Update a specific note for a specific list member.
Delete note
delete
/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}
Delete a specific note for a specific list member.
Lists/Audiences
Member Tags
Manage all the tags that have been assigned to a contact.
List member tags
get
/lists/{list_id}/members/{subscriber_hash}/tags
Get the tags on a list member.
Add or remove member tags
post
/lists/{list_id}/members/{subscriber_hash}/tags
Add or remove tags from a list member. If a tag that does not exist is passed in and set as 'active', a new tag will be created.
Lists/Audiences
Members
Manage members of a specific Mailchimp list, including currently subscribed, unsubscribed, and bounced members.
List members info
get
/lists/{list_id}/members
Get information about members in a specific Mailchimp list.
Add member to list
post
/lists/{list_id}/members
Add a new member to the list.
Get member info
get
/lists/{list_id}/members/{subscriber_hash}
Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member.
Add or update list member
put
/lists/{list_id}/members/{subscriber_hash}
Add or update a list member.
Update list member
patch
/lists/{list_id}/members/{subscriber_hash}
Update information for a specific list member.
Archive list member
delete
/lists/{list_id}/members/{subscriber_hash}
Archive a list member. To permanently delete, use the delete-permanent action.
Delete list member
post
/lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent
Delete all personally identifiable information related to a list member, and remove them from a list. This will make it impossible to re-import the list member.
List merge fields
get
/lists/{list_id}/merge-fields
Get a list of all merge fields (audience fields) for a list.
Add merge field
post
/lists/{list_id}/merge-fields
Add a new merge field (audience field) for a specific list.
Get merge field
get
/lists/{list_id}/merge-fields/{merge_id}
Get information about a specific merge field (audience field) in a list.
Update merge field
patch
/lists/{list_id}/merge-fields/{merge_id}
Update a specific merge field (audience field) in a list.
Delete merge field
delete
/lists/{list_id}/merge-fields/{merge_id}
Delete a specific merge field (audience field) in a list.
Lists/Audiences
Segment Members
Manage list members in a saved segment.
List members in segment
get
/lists/{list_id}/segments/{segment_id}/members
Get information about members in a saved segment.
Add member to segment
post
/lists/{list_id}/segments/{segment_id}/members
Add a member to a static segment.
Remove list member from segment
delete
/lists/{list_id}/segments/{segment_id}/members/{subscriber_hash}
Remove a member from the specified static segment.
Lists/Audiences
Segments
Manage segments and tags for a specific Mailchimp list. A segment is a section of your list that includes only those subscribers who share specific common field information. Tags are labels you create to help organize your contacts.
List segments
get
/lists/{list_id}/segments
Get information about all available segments for a specific list.
Add segment
post
/lists/{list_id}/segments
Create a new segment in a specific list.
Get segment info
get
/lists/{list_id}/segments/{segment_id}
Get information about a specific segment.
Delete segment
delete
/lists/{list_id}/segments/{segment_id}
Delete a specific segment in a list.
Update segment
patch
/lists/{list_id}/segments/{segment_id}
Update a specific segment in a list.
Batch add or remove members
post
/lists/{list_id}/segments/{segment_id}
Batch add/remove list members to static segment
Lists/Audiences
Signup Forms
Manage list signup forms.
List signup forms
get
/lists/{list_id}/signup-forms
Get signup forms for a specific list.
Customize signup form
post
/lists/{list_id}/signup-forms
Customize a list's default signup form.
Lists/Audiences
Tag Search
Search for tags on a list by name.
Search for tags on a list by name.
get
/lists/{list_id}/tag-search
Search for tags on a list by name. If no name is provided, will return all tags on the list.
Lists/Audiences
Webhooks
Manage webhooks for a specific Mailchimp list.
List webhooks
get
/lists/{list_id}/webhooks
Get information about all webhooks for a specific list.
Add webhook
post
/lists/{list_id}/webhooks
Create a new webhook for a specific list.
Get webhook info
get
/lists/{list_id}/webhooks/{webhook_id}
Get information about a specific webhook.
Delete webhook
delete
/lists/{list_id}/webhooks/{webhook_id}
Delete a specific webhook in a list.
Update webhook
patch
/lists/{list_id}/webhooks/{webhook_id}
Update the settings for an existing webhook.
Ping
A health check endpoint for Mailchimp API 3.0.
Ping
get
/ping
A health check for the API that won't return any account-specific information.
Reporting
Reporting for various campaign types.
Reporting
Facebook Ads
Get information about Facebook Ad reports.
List facebook ads reports
get
/reporting/facebook-ads
Get reports of Facebook ads.
Get facebook ad report
get
/reporting/facebook-ads/{outreach_id}
Get report of a Facebook ad.
List facebook ecommerce report
get
/reporting/facebook-ads/{outreach_id}/ecommerce-product-activity
Get breakdown of product activity for an outreach.
Reporting
Landing Pages
Get information about Landing Page reports.
List landing pages reports
get
/reporting/landing-pages
Get reports of landing pages.
Get landing page report
get
/reporting/landing-pages/{outreach_id}
Get report of a landing page.
Reports
Manage campaign reports for your Mailchimp account. All Reports endpoints are read-only. Mailchimp's campaign and automation reports analyze clicks, opens, subscribers' social activity, e-commerce data, and more. Note: Campaign IDs for A/B Testing Campaigns are available through the Campaign API Endpoint's Read method.
List campaign reports
get
/reports
Get campaign reports.
Get campaign report
get
/reports/{campaign_id}
Get report details for a specific sent campaign.
Reports
Campaign Abuse
Get information about campaign abuse complaints.
List abuse reports
get
/reports/{campaign_id}/abuse-reports
Get a list of abuse complaints for a specific campaign.
Get abuse report
get
/reports/{campaign_id}/abuse-reports/{report_id}
Get information about a specific abuse report for a campaign.
Reports
Campaign Advice
Get recent feedback based on a campaign's statistics.
List campaign feedback
get
/reports/{campaign_id}/advice
Get feedback based on a campaign's statistics. Advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more.
Reports
Campaign Open Reports
Get a detailed report about any emails in a specific campaign that were opened by the recipient.
List campaign open details
get
/reports/{campaign_id}/open-details
Get detailed information about any campaign emails that were opened by a list member.
Get opened campaign subscriber
get
/reports/{campaign_id}/open-details/{subscriber_hash}
Get information about a specific subscriber who opened a campaign.
Reports
Click Reports
Get detailed information about links clicked in campaigns.
List campaign details
get
/reports/{campaign_id}/click-details
Get information about clicks on specific links in your Mailchimp campaigns.
Get campaign link details
get
/reports/{campaign_id}/click-details/{link_id}
Get click details for a specific link in a campaign.
Reports
Click Reports Members
Get information about specific subscribers who clicked on links in a campaign.
List clicked link subscribers
get
/reports/{campaign_id}/click-details/{link_id}/members
Get information about list members who clicked on a specific link in a campaign.
Get clicked link subscriber
get
/reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}
Get information about a specific subscriber who clicked a link in a specific campaign.
Reports
Domain Performance
Get statistics for the top-performing domains from a campaign.
List domain performance stats
get
/reports/{campaign_id}/domain-performance
Get statistics for the top-performing email domains in a campaign.
Reports
Ecommerce Product Activity
Ecommerce product activity report for a campaign.
List campaign product activity
get
/reports/{campaign_id}/ecommerce-product-activity
Get breakdown of product activity for a campaign
Reports
EepURL Reports
Get a summary of social activity for the campaign, tracked by EepURL.
List EepURL activity
get
/reports/{campaign_id}/eepurl
Get a summary of social activity for the campaign, tracked by EepURL.
Reports
Email Activity
Get list member activity for a specific campaign.
List email activity
get
/reports/{campaign_id}/email-activity
Get a list of member's subscriber activity in a specific campaign.
Get subscriber email activity
get
/reports/{campaign_id}/email-activity/{subscriber_hash}
Get a specific list member's activity in a campaign including opens, clicks, and bounces.
Reports
Location
Get top open locations for a specific campaign.
List top open activities
get
/reports/{campaign_id}/locations
Get top open locations for a specific campaign.
Reports
Sent To
Get details about campaign recipients.
List campaign recipients
get
/reports/{campaign_id}/sent-to
Get information about campaign recipients.
Get campaign recipient info
get
/reports/{campaign_id}/sent-to/{subscriber_hash}
Get information about a specific campaign recipient.
Reports
Sub-Reports
A list of reports for child campaigns of a specific parent campaign. For example, use this endpoint to view Multivariate, RSS, and A/B Testing Campaign reports.
List child campaign reports
get
/reports/{campaign_id}/sub-reports
Get a list of reports with child campaigns for a specific parent campaign.
Reports
Unsubscribes
Get information about list members who unsubscribed from a specific campaign.
List unsubscribed members
get
/reports/{campaign_id}/unsubscribed
Get information about members who have unsubscribed from a specific campaign.
Get unsubscribed member
get
/reports/{campaign_id}/unsubscribed/{subscriber_hash}
Get information about a specific list member who unsubscribed from a campaign.
Search Campaigns
Search all of an account's campaigns for the specified query terms.
Search campaigns
get
/search-campaigns
Search all campaigns for the specified query terms.
Search Members
Search the account or a specific list for members that match the specified query terms.
Search members
get
/search-members
Search for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account.
Template Folders
Organize your templates using folders.
List template folders
get
/template-folders
Get all folders used to organize templates.
Add template folder
post
/template-folders
Create a new template folder.
Get template folder
get
/template-folders/{folder_id}
Get information about a specific folder used to organize templates.
Update template folder
patch
/template-folders/{folder_id}
Update a specific folder used to organize templates.
Delete template folder
delete
/template-folders/{folder_id}
Delete a specific template folder, and mark all the templates in the folder as 'unfiled'.
Templates
Manage your Mailchimp templates. A template is an HTML file used to create the layout and basic design for a campaign.
List templates
get
/templates
Get a list of an account's available templates.
Add template
post
/templates
Create a new template for the account. Only Classic templates are supported.
Get template info
get
/templates/{template_id}
Get information about a specific template.
Update template
patch
/templates/{template_id}
Update the name, HTML, or
folder_idof an existing template.Delete template
delete
/templates/{template_id}
Delete a specific template.
Templates
Default Content
Manage the default content for a Mailchimp template.
View default content
get
/templates/{template_id}/default-content
Get the sections that you can edit in a template, including each section's default content.
Verified Domains
Manage the domains on your account that can be used for sending email campaigns.
List sending domains
get
/verified-domains
Get all of the sending domains on the account.
Add domain to account
post
/verified-domains
Add a domain to the account.
Get domain info
get
/verified-domains/{domain_name}
Get the details for a single domain on the account.
Delete domain
delete
/verified-domains/{domain_name}
Delete a verified domain from the account.
Verify domain
post
/verified-domains/{domain_name}/actions/verify
Verify a domain for sending.