Overview

Quickly review all available resources for MailChimp API 3.0 with this reference overview.

Learn the basics of the MailChimp API in our Getting Started guide, or explore the API with your own data in the Playground.

Overview

API Root

HTTP method Endpoint Function
GET / API Root

Authorized Apps

HTTP method Endpoint Function
POST /authorized-apps Link your application
GET /authorized-apps Get a list of authorized apps
GET /authorized-apps/{app_id} Get information about a specific authorized app

Automations

HTTP method Endpoint Function
GET /automations Get a list of Automations
GET /automations/{workflow_id} Get information about a specific Automation workflow
POST /automations/{workflow_id}/actions/pause-all-emails Pause all emails in an Automation workflow
POST /automations/{workflow_id}/actions/start-all-emails Start all emails in an Automation workflow
GET /automations/{workflow_id}/emails Get a list of automated emails in a workflow
GET /automations/{workflow_id}/emails/{workflow_email_id} Get information about a specific workflow email
POST /automations/{workflow_id}/emails/{workflow_email_id}/actions/pause Pause an automated email
POST /automations/{workflow_id}/emails/{workflow_email_id}/actions/start Start an automated email
POST /automations/{workflow_id}/emails/{workflow_email_id}/queue Add a subscriber to a workflow email
GET /automations/{workflow_id}/emails/{workflow_email_id}/queue View queued subscribers for an automated email
GET /automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash} View specific subscriber in email queue
POST /automations/{workflow_id}/removed-subscribers Remove subscriber from a workflow
GET /automations/{workflow_id}/removed-subscribers View all subscribers removed from a workflow

Batch Operations

HTTP method Endpoint Function
POST /batches Start a batch operation
GET /batches Get a list of batch requests
GET /batches/{batch_id} Get the status of a batch operation request
DELETE /batches/{batch_id} Delete a batch request and stop if from processing further.

Campaign Folders

HTTP method Endpoint Function
POST /campaign-folders Create campaign folder
GET /campaign-folders Get all campaign folders
GET /campaign-folders/{folder_id} Get a specific campaign folder
PATCH /campaign-folders/{folder_id} Update a campaign folder
DELETE /campaign-folders/{folder_id} Delete a campaign folder

Campaigns

HTTP method Endpoint Function
POST /campaigns Create a new campaign
GET /campaigns Get all campaigns
GET /campaigns/{campaign_id} Get information about a specific campaign
PATCH /campaigns/{campaign_id} Update the settings for a campaign
DELETE /campaigns/{campaign_id} Delete a campaign
POST /campaigns/{campaign_id}/actions/cancel-send Cancel a campaign
POST /campaigns/{campaign_id}/actions/pause Pause an RSS-Driven campaign
POST /campaigns/{campaign_id}/actions/replicate Replicate a campaign
POST /campaigns/{campaign_id}/actions/resume Resume an RSS-Driven campaign
POST /campaigns/{campaign_id}/actions/schedule Schedule a campaign
POST /campaigns/{campaign_id}/actions/send Send a campaign
POST /campaigns/{campaign_id}/actions/test Send a test email
POST /campaigns/{campaign_id}/actions/unschedule Unschedule a campaign
GET /campaigns/{campaign_id}/content Get campaign content
PUT /campaigns/{campaign_id}/content Set campaign content
POST /campaigns/{campaign_id}/feedback Add campaign feedback
GET /campaigns/{campaign_id}/feedback Get feedback about a campaign
GET /campaigns/{campaign_id}/feedback/{feedback_id} Get a specific feedback message
PATCH /campaigns/{campaign_id}/feedback/{feedback_id} Update a campaign feedback message
DELETE /campaigns/{campaign_id}/feedback/{feedback_id} Delete a campaign feedback message
GET /campaigns/{campaign_id}/send-checklist Get the send checklist for a campaign

Conversations

HTTP method Endpoint Function
GET /conversations Get a list of conversations
GET /conversations/{conversation_id} Get information about a conversation
POST /conversations/{conversation_id}/messages Post a new conversation message
GET /conversations/{conversation_id}/messages Get conversation messages
GET /conversations/{conversation_id}/messages/{message_id} Get a specific conversation message

E-commerce Stores

HTTP method Endpoint Function
POST /ecommerce/stores Add a new store
GET /ecommerce/stores Get information about all stores
GET /ecommerce/stores/{store_id} Get information about a specific store
PATCH /ecommerce/stores/{store_id} Update a store
DELETE /ecommerce/stores/{store_id} Delete a store
POST /ecommerce/stores/{store_id}/carts Add a new cart to a store
GET /ecommerce/stores/{store_id}/carts Get information about a store’s carts
GET /ecommerce/stores/{store_id}/carts/{cart_id} Get information about a specific cart
PATCH /ecommerce/stores/{store_id}/carts/{cart_id} Update a specific cart
DELETE /ecommerce/stores/{store_id}/carts/{cart_id} Delete a cart
POST /ecommerce/stores/{store_id}/carts/{cart_id}/lines Add a new line item to an existing cart
GET /ecommerce/stores/{store_id}/carts/{cart_id}/lines Get information about a cart’s line items
GET /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} Get information about a specific cart line item
PATCH /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} Update a specific cart line item
DELETE /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} Delete a specific cart line item
POST /ecommerce/stores/{store_id}/customers Add a new customer to a store
GET /ecommerce/stores/{store_id}/customers Get information about a store’s customers
GET /ecommerce/stores/{store_id}/customers/{customer_id} Get information about a specific customer
PATCH /ecommerce/stores/{store_id}/customers/{customer_id} Update a customer
PUT /ecommerce/stores/{store_id}/customers/{customer_id} Add or update a customer
DELETE /ecommerce/stores/{store_id}/customers/{customer_id} Delete a customer
POST /ecommerce/stores/{store_id}/orders Add a new order to a store
GET /ecommerce/stores/{store_id}/orders Get information about a store’s orders
GET /ecommerce/stores/{store_id}/orders/{order_id} Get information about a specific order
PATCH /ecommerce/stores/{store_id}/orders/{order_id} Update a specific order
DELETE /ecommerce/stores/{store_id}/orders/{order_id} Delete an order
POST /ecommerce/stores/{store_id}/orders/{order_id}/lines Add a new line item to an existing order
GET /ecommerce/stores/{store_id}/orders/{order_id}/lines Get information about an order’s line items.
GET /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} Get information about a specific order line item
PATCH /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} Update a specific order line item
DELETE /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} Delete a specific order line item
POST /ecommerce/stores/{store_id}/products Add a new product to a store
GET /ecommerce/stores/{store_id}/products Get information about a store’s products.
GET /ecommerce/stores/{store_id}/products/{product_id} Get information about a specific product
DELETE /ecommerce/stores/{store_id}/products/{product_id} Delete a product
POST /ecommerce/stores/{store_id}/products/{product_id}/variants Add a new variant to the product.
GET /ecommerce/stores/{store_id}/products/{product_id}/variants Get information about a product’s variants.
GET /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} Get information about a specific product variant
PATCH /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} Update a product variant
PUT /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} Add or update a product variant
DELETE /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} Delete a product variant

File Manager Files

HTTP method Endpoint Function
POST /file-manager/files Upload a new file
GET /file-manager/files Get information about stored files
GET /file-manager/files/{file_id} Get a specific file
PATCH /file-manager/files/{file_id} Update a specific file
DELETE /file-manager/files/{file_id} Remove a specific file

File Manager Folders

HTTP method Endpoint Function
POST /file-manager/folders Create a new folder
GET /file-manager/folders Get a list of folders in the File Manager
GET /file-manager/folders/{folder_id} Get information about a specific folder
PATCH /file-manager/folders/{folder_id} Update a File Manager folder
DELETE /file-manager/folders/{folder_id} Remove a File Manager folder

Lists

HTTP method Endpoint Function
POST /lists Create a new list
GET /lists Get information about all lists
POST /lists/{list_id} Batch sub/unsub list members
GET /lists/{list_id} Get information about a specific list
PATCH /lists/{list_id} Update a specific list
DELETE /lists/{list_id} Delete a list
GET /lists/{list_id}/abuse-reports Get information about abuse reports
GET /lists/{list_id}/abuse-reports/{report_id} Get details about a specific abuse report
GET /lists/{list_id}/activity Get recent list activity
GET /lists/{list_id}/clients Get top email clients
GET /lists/{list_id}/growth-history Get list growth history data
GET /lists/{list_id}/growth-history/{month} Get list growth history by month
POST /lists/{list_id}/interest-categories Create a new interest category
GET /lists/{list_id}/interest-categories Get information about a list’s interest categories
GET /lists/{list_id}/interest-categories/{interest_category_id} Get information about a specific interest category
PATCH /lists/{list_id}/interest-categories/{interest_category_id} Update a specific interest category
DELETE /lists/{list_id}/interest-categories/{interest_category_id} Delete a specific interest category
POST /lists/{list_id}/interest-categories/{interest_category_id}/interests Create a new interest in a specific category
GET /lists/{list_id}/interest-categories/{interest_category_id}/interests Get all interests in a specific category
GET /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id} Get interests in a specific category
PATCH /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id} Update interests in a specific category
DELETE /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id} Delete interests in a specific category
POST /lists/{list_id}/members Add a new list member
GET /lists/{list_id}/members Get information about members in a list
GET /lists/{list_id}/members/{subscriber_hash} Get information about a specific list member
PATCH /lists/{list_id}/members/{subscriber_hash} Update a list member
PUT /lists/{list_id}/members/{subscriber_hash} Add or update a list member
DELETE /lists/{list_id}/members/{subscriber_hash} Remove a list member
GET /lists/{list_id}/members/{subscriber_hash}/activity Get recent list member activity
GET /lists/{list_id}/members/{subscriber_hash}/goals Get the last 50 Goal events for a member on a specific list
POST /lists/{list_id}/members/{subscriber_hash}/notes Add a new note
GET /lists/{list_id}/members/{subscriber_hash}/notes Get recent notes for a specific list member
GET /lists/{list_id}/members/{subscriber_hash}/notes/{note_id} Get a specific note for a specific list member
PATCH /lists/{list_id}/members/{subscriber_hash}/notes/{note_id} Update a note
DELETE /lists/{list_id}/members/{subscriber_hash}/notes/{note_id} Delete a note
POST /lists/{list_id}/merge-fields Add a new merge field
GET /lists/{list_id}/merge-fields Get all merge fields for a list
GET /lists/{list_id}/merge-fields/{merge_id} Get a specific merge field
PATCH /lists/{list_id}/merge-fields/{merge_id} Update a merge field
DELETE /lists/{list_id}/merge-fields/{merge_id} Delete a merge field
POST /lists/{list_id}/segments Create a new segment
GET /lists/{list_id}/segments Get information about all segments in a list
GET /lists/{list_id}/segments/{segment_id} Get information about a specific segment
PATCH /lists/{list_id}/segments/{segment_id} Update a segment
DELETE /lists/{list_id}/segments/{segment_id} Delete a segment
POST /lists/{list_id}/segments/{segment_id}/members Add a member to a static segment
GET /lists/{list_id}/segments/{segment_id}/members Get information about all members in a list segment
DELETE /lists/{list_id}/segments/{segment_id}/members/{subscriber_hash} Remove a member from the specified static segment
POST /lists/{list_id}/signup-forms Create a new list signup form
GET /lists/{list_id}/signup-forms Get signup forms for a specific list
POST /lists/{list_id}/twitter-lead-gen-cards Create a new Twitter Lead Generation Card
GET /lists/{list_id}/twitter-lead-gen-cards Get information about all Twitter Lead Generation Cards for a specific list
GET /lists/{list_id}/twitter-lead-gen-cards/{twitter_card_id} Get information about a specific Twitter Lead Generation Card
POST /lists/{list_id}/webhooks Create a new webhook
GET /lists/{list_id}/webhooks Get information about all webhooks for a specific list
GET /lists/{list_id}/webhooks/{webhook_id} Get information about a specific webhook
DELETE /lists/{list_id}/webhooks/{webhook_id} Delete a webhook

Reports

HTTP method Endpoint Function
GET /reports Get campaign reports
GET /reports/{campaign_id} Get a specific campaign report
GET /reports/{campaign_id}/abuse-reports Get abuse complaints for a campaign
GET /reports/{campaign_id}/abuse-reports/{report_id} Get information about a specific abuse report
GET /reports/{campaign_id}/advice Get campaign feedback
GET /reports/{campaign_id}/click-details Get campaign click details
GET /reports/{campaign_id}/click-details/{link_id} Get click details for a specific link
GET /reports/{campaign_id}/click-details/{link_id}/members Get information about subscribers who clicked a link
GET /reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash} Get information about a specific subscriber who clicked a link
GET /reports/{campaign_id}/domain-performance Get domain performance stats
GET /reports/{campaign_id}/eepurl Get Eepurl activity
GET /reports/{campaign_id}/email-activity Get email activity
GET /reports/{campaign_id}/email-activity/{subscriber_hash} Get email activity for a specific subscriber
GET /reports/{campaign_id}/locations Get top open locations
GET /reports/{campaign_id}/sent-to Get information about campaign recipients
GET /reports/{campaign_id}/sent-to/{subscriber_hash} Get information about a specific campaign recipient
GET /reports/{campaign_id}/sub-reports Get reports for child campaigns
GET /reports/{campaign_id}/unsubscribed Get unsubscribed list members
GET /reports/{campaign_id}/unsubscribed/{subscriber_hash} Get information about a specific list member who unsubscribed

Template Folders

HTTP method Endpoint Function
POST /template-folders Create a template folder
GET /template-folders Get all template folders
GET /template-folders/{folder_id} Get a template folder
PATCH /template-folders/{folder_id} Update a template folder
DELETE /template-folders/{folder_id} Delete a template folder

Templates

HTTP method Endpoint Function
POST /templates Create a new template
GET /templates Get all templates
GET /templates/{template_id} Get information about a specific template
PATCH /templates/{template_id} Update an existing template
DELETE /templates/{template_id} Delete a specific template
GET /templates/{template_id}/default-content Get the default content for a template
Back to top