matimo-mailchimp

Mailchimp tools for Matimo - manage campaigns, lists, and subscribers.

Installation

pip install matimo matimo-mailchimp

Available Tools (7 Total)

Quick Start

import asyncio
import os
from matimo import Matimo
from matimo_mailchimp import get_tools_path

async def main():
    matimo = await Matimo.init(get_tools_path())

    # List all audiences (server_prefix is required on every call)
    lists = await matimo.execute('mailchimp-get-lists', {
        'server_prefix': 'us1',
    })
    print(lists)

    # Add a subscriber
    await matimo.execute('mailchimp-add-list-member', {
        'server_prefix': 'us1',
        'list_id': 'abc123def',
        'email_address': 'new@example.com',
        'status': 'subscribed',
        'merge_fields': {'FNAME': 'Jane', 'LNAME': 'Doe'},
    })

    # Create and send a campaign
    campaign = await matimo.execute('mailchimp-create-campaign', {
        'server_prefix': 'us1',
        'list_id': 'abc123def',
        'subject_line': 'April Newsletter',
        'from_name': 'My Company',
        'reply_to': 'hello@example.com',
    })
    await matimo.execute('mailchimp-send-campaign', {
        'server_prefix': 'us1',
        'campaign_id': campaign['id'],
    })

asyncio.run(main())

Authentication

export MAILCHIMP_API_KEY="your-api-key-us1"     # includes datacenter suffix

Every tool also requires a server_prefix parameter (e.g. 'us1') passed directly in the call - it is not read from an environment variable.

Getting Mailchimp API Credentials

1. Log in to Mailchimp → Profile → Extras → API keys
2. Click Create A Key
3. Copy the API key - the suffix (us1, us6, etc.) is your server prefix, used as the server_prefix parameter

Documentation

• Mailchimp Marketing API
• Python Examples

Links

• PyPI: https://pypi.org/project/matimo-mailchimp/
• GitHub: https://github.com/tallclub/matimo
• Mailchimp Developer Docs: https://mailchimp.com/developer/