Mailchimp Marketing Python SDK

<p align="center">

<a href="https://mailchimp.com/developer/">

<img src="https://raw.githubusercontent.com/mailchimp/mailchimp-client-lib-codegen/main/resources/images/mcdev-banner.png" alt="Mailchimp Developer" width="100%" height="auto">

</a>

</p>

Mailchimp Marketing — Python

The official Python client library for the Mailchimp Marketing API

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on GitHub, you can install directly from GitHub

pip install git+https://github.com/mailchimp/mailchimp-marketing-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/mailchimp/mailchimp-marketing-python.git)

Then import the package:

import mailchimp_marketing

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import mailchimp_marketing

Quick Start

Please follow the installation procedure and then run the following:

import mailchimp_marketing as MailchimpMarketing
from mailchimp_marketing.api_client import ApiClientError

try:
  client = MailchimpMarketing.Client()
  client.set_config({
    "api_key": "YOUR_API_KEY",
    "server": "YOUR_SERVER_PREFIX"
  })
  response = client.ping.get()
  print(response)
except ApiClientError as error:
  print(error)

Authentication Methods

The client library can be configured to use either Basic Auth or OAuth2.

For either method, a server prefix should be passed in i.e. us19, in order for the client to determine to appropriate host url.

Basic Auth

client.set_config({
  "api_key": "YOUR_API_KEY",
  "server": "YOUR_SERVER_PREFIX"
})

OAuth2

client.set_config({
  "access_token": "YOUR_ACCESS_TOKEN",
  "server": "YOUR_SERVER_PREFIX"
})

PRs and Issues

This repo is autogenerated from https://github.com/mailchimp/mailchimp-client-lib-codegen -- please submit PRs or issues there!

API Endpoints

All URIs are relative to https://server.api.mailchimp.com/3.0

| Method | Endpoint |

| ---------- | -------- |

| Surveys.publish_survey | /lists/{list_id}/surveys/{survey_id}/actions/publish |

| Surveys.unpublish_survey | /lists/{list_id}/surveys/{survey_id}/actions/unpublish |

| accountExport.get_account_exports | /account-exports/{export_id} |

| accountExports.list_account_exports | /account-exports |

| accountExports.create_account_export | /account-exports |

| activityFeed.get_chimp_chatter | /activity-feed/chimp-chatter |

| authorizedApps.list | /authorized-apps |

| authorizedApps.get | /authorized-apps/{app_id} |

| automations.archive | /automations/{workflow_id}/actions/archive |

| automations.delete_workflow_email | /automations/{workflow_id}/emails/{workflow_email_id} |

| automations.list | /automations |

| automations.get | /automations/{workflow_id} |

| automations.list_all_workflow_emails | /automations/{workflow_id}/emails |

| automations.get_workflow_email | /automations/{workflow_id}/emails/{workflow_email_id} |

| automations.get_workflow_email_subscriber_queue | /automations/{workflow_id}/emails/{workflow_email_id}/queue |

| automations.get_workflow_email_subscriber | /automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash} |

| automations.list_workflow_email_subscribers_removed | /automations/{workflow_id}/removed-subscribers |

| automations.get_removed_workflow_email_subscriber | /automations/{workflow_id}/removed-subscribers/{subscriber_hash} |

| automations.update_workflow_email | /automations/{workflow_id}/emails/{workflow_email_id} |

| automations.create | /automations |

| automations.pause_all_emails | /automations/{workflow_id}/actions/pause-all-emails |

| automations.start_all_emails | /automations/{workflow_id}/actions/start-all-emails |

| automations.pause_workflow_email | /automations/{workflow_id}/emails/{workflow_email_id}/actions/pause |

| automations.start_workflow_email | /automations/{workflow_id}/emails/{workflow_email_id}/actions/start |

| automations.add_workflow_email_subscriber | /automations/{workflow_id}/emails/{workflow_email_id}/queue |

| automations.remove_workflow_email_subscriber | /automations/{workflow_id}/removed-subscribers |

| batchWebhooks.remove | /batch-webhooks/{batch_webhook_id} |

| batchWebhooks.get | /batch-webhooks/{batch_webhook_id} |

| batchWebhooks.list | /batch-webhooks |

| batchWebhooks.update | /batch-webhooks/{batch_webhook_id} |

| batchWebhooks.create | /batch-webhooks |

| batches.delete_request | /batches/{batch_id} |

| batches.list | /batches |

| batches.status | /batches/{batch_id} |

| batches.start | /batches |

| campaignFolders.remove | /campaign-folders/{folder_id} |

| campaignFolders.list | /campaign-folders |

| campaignFolders.get | /campaign-folders/{folder_id} |

| campaignFolders.update | /campaign-folders/{folder_id} |

| campaignFolders.create | /campaign-folders |

| campaigns.remove | /campaigns/{campaign_id} |

| campaigns.delete_feedback_message | /campaigns/{campaign_id}/feedback/{feedback_id} |

| campaigns.list | /campaigns |

| campaigns.get | /campaigns/{campaign_id} |

| campaigns.get_content | /campaigns/{campaign_id}/content |

| campaigns.get_feedback | /campaigns/{campaign_id}/feedback |

| campaigns.get_feedback_message | /campaigns/{campaign_id}/feedback/{feedback_id} |

| campaigns.get_send_checklist | /campaigns/{campaign_id}/send-checklist |

| campaigns.update | /campaigns/{campaign_id} |

| campaigns.update_feedback_message | /campaigns/{campaign_id}/feedback/{feedback_id} |

| campaigns.create | /campaigns |

| campaigns.cancel_send | /campaigns/{campaign_id}/actions/cancel-send |

| campaigns.create_resend | /campaigns/{campaign_id}/actions/create-resend |

| campaigns.pause | /campaigns/{campaign_id}/actions/pause |

| campaigns.replicate | /campaigns/{campaign_id}/actions/replicate |

| campaigns.resume | /campaigns/{campaign_id}/actions/resume |

| campaigns.schedule | /campaigns/{campaign_id}/actions/schedule |

| campaigns.send | /campaigns/{campaign_id}/actions/send |

| campaigns.send_test_email | /campaigns/{campaign_id}/actions/test |

| campaigns.unschedule | /campaigns/{campaign_id}/actions/unschedule |

| campaigns.add_feedback | /campaigns/{campaign_id}/feedback |

| campaigns.set_content | /campaigns/{campaign_id}/content |

| connectedSites.remove | /connected-sites/{connected_site_id} |

| connectedSites.list | /connected-sites |

| connectedSites.get | /connected-sites/{connected_site_id} |

| connectedSites.create | /connected-sites |

| connectedSites.verify_script_installation | /connected-sites/{connected_site_id}/actions/verify-script-installation |

| conversations.list | /conversations |

| conversations.get | /conversations/{conversation_id} |

| conversations.get_conversation_messages | /conversations/{conversation_id}/messages |

| conversations.get_conversation_message | /conversations/{conversation_id}/messages/{message_id} |

| customerJourneys.trigger | /customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger |

| ecommerce.delete_store | /ecommerce/stores/{store_id} |

| ecommerce.delete_store_cart | /ecommerce/stores/{store_id}/carts/{cart_id} |

| ecommerce.delete_cart_line_item | /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} |

| ecommerce.delete_store_customer | /ecommerce/stores/{store_id}/customers/{customer_id} |

| ecommerce.delete_order | /ecommerce/stores/{store_id}/orders/{order_id} |

| ecommerce.delete_order_line_item | /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} |

| ecommerce.delete_store_product | /ecommerce/stores/{store_id}/products/{product_id} |

| ecommerce.delete_product_image | /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} |

| ecommerce.delete_product_variant | /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} |

| ecommerce.delete_promo_code | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id} |

| ecommerce.delete_promo_rule | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id} |

| ecommerce.orders | /ecommerce/orders |

| ecommerce.stores | /ecommerce/stores |

| ecommerce.get_store | /ecommerce/stores/{store_id} |

| ecommerce.get_store_carts | /ecommerce/stores/{store_id}/carts |

| ecommerce.get_store_cart | /ecommerce/stores/{store_id}/carts/{cart_id} |

| ecommerce.get_all_cart_line_items | /ecommerce/stores/{store_id}/carts/{cart_id}/lines |

| ecommerce.get_cart_line_item | /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} |

| ecommerce.get_all_store_customers | /ecommerce/stores/{store_id}/customers |

| ecommerce.get_store_customer | /ecommerce/stores/{store_id}/customers/{customer_id} |

| ecommerce.get_store_orders | /ecommerce/stores/{store_id}/orders |

| ecommerce.get_order | /ecommerce/stores/{store_id}/orders/{order_id} |

| ecommerce.get_all_order_line_items | /ecommerce/stores/{store_id}/orders/{order_id}/lines |

| ecommerce.get_order_line_item | /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} |

| ecommerce.get_all_store_products | /ecommerce/stores/{store_id}/products |

| ecommerce.get_store_product | /ecommerce/stores/{store_id}/products/{product_id} |

| ecommerce.get_product_images | /ecommerce/stores/{store_id}/products/{product_id}/images |

| ecommerce.get_product_image | /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} |

| ecommerce.get_product_variants | /ecommerce/stores/{store_id}/products/{product_id}/variants |

| ecommerce.get_product_variant | /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} |

| ecommerce.get_promo_codes | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes |

| ecommerce.get_promo_code | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id} |

| ecommerce.list_promo_rules | /ecommerce/stores/{store_id}/promo-rules |

| ecommerce.get_promo_rule | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id} |

| ecommerce.update_store | /ecommerce/stores/{store_id} |

| ecommerce.update_store_cart | /ecommerce/stores/{store_id}/carts/{cart_id} |

| ecommerce.update_cart_line_item | /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} |

| ecommerce.update_store_customer | /ecommerce/stores/{store_id}/customers/{customer_id} |

| ecommerce.update_order | /ecommerce/stores/{store_id}/orders/{order_id} |

| ecommerce.update_order_line_item | /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} |

| ecommerce.update_store_product | /ecommerce/stores/{store_id}/products/{product_id} |

| ecommerce.update_product_image | /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} |

| ecommerce.update_product_variant | /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} |

| ecommerce.update_promo_code | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id} |

| ecommerce.update_promo_rule | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id} |

| ecommerce.add_store | /ecommerce/stores |

| ecommerce.add_store_cart | /ecommerce/stores/{store_id}/carts |

| ecommerce.add_cart_line_item | /ecommerce/stores/{store_id}/carts/{cart_id}/lines |

| ecommerce.add_store_customer | /ecommerce/stores/{store_id}/customers |

| ecommerce.add_store_order | /ecommerce/stores/{store_id}/orders |

| ecommerce.add_order_line_item | /ecommerce/stores/{store_id}/orders/{order_id}/lines |

| ecommerce.add_store_product | /ecommerce/stores/{store_id}/products |

| ecommerce.add_product_image | /ecommerce/stores/{store_id}/products/{product_id}/images |

| ecommerce.add_product_variants | /ecommerce/stores/{store_id}/products/{product_id}/variants |

| ecommerce.add_promo_code | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes |

| ecommerce.add_promo_rules | /ecommerce/stores/{store_id}/promo-rules |

| ecommerce.set_store_customer | /ecommerce/stores/{store_id}/customers/{customer_id} |

| ecommerce.add_product_variant | /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} |

| facebookAds.list | /facebook-ads |

| facebookAds.get_ad | /facebook-ads/{outreach_id} |

| fileManager.delete_file | /file-manager/files/{file_id} |

| fileManager.delete_folder | /file-manager/folders/{folder_id} |

| fileManager.files | /file-manager/files |

| fileManager.get_file | /file-manager/files/{file_id} |

| fileManager.list_folders | /file-manager/folders |

| fileManager.get_folder | /file-manager/folders/{folder_id} |

| fileManager.update_file | /file-manager/files/{file_id} |

| fileManager.update_folder | /file-manager/folders/{folder_id} |

| fileManager.upload | /file-manager/files |

| fileManager.create_folder | /file-manager/folders |

| landingPages.delete_page | /landing-pages/{page_id} |

| landingPages.get_all | /landing-pages |

| landingPages.get_page | /landing-pages/{page_id} |

| landingPages.get_page_content | /landing-pages/{page_id}/content |

| landingPages.update_page | /landing-pages/{page_id} |

| landingPages.create | /landing-pages |

| landingPages.publish_page | /landing-pages/{page_id}/actions/publish |

| landingPages.unpublish_page | /landing-pages/{page_id}/actions/unpublish |

| lists.delete_list | /lists/{list_id}