Skip to main content

Python Wrapper for Mailerlite API

Project description

Mailerlite-api-python

Python Wrapper for Mailerlite API v2

Getting Started

Installation

This client is hosted at PyPi under the name mailerlite-api-python, to install it, simply run

pip install mailerlite-api-python

Examples

Initialization

First, Grab YOUR_API_KEY from your Mailerlite account (Profile > Integrations > Developer Api).

from mailerlite import MailerLiteApi

api = MailerLiteApi('YOUR_API_KEY')

Campaigns

Get all campaigns or a specific one

all_campaigns = api.campaigns.all()
draft = api.compaings.all(status='draft')

Modify a campaign

one_campaign = all_campaigns[0]
html = '<h1>Title</h1><p>Content</p><p><small><a href=\"{$unsubscribe}\">Unsubscribe</a></small></p>'
plain = "Your email client does not support HTML emails. "
plain += "Open newsletter here: {$url}. If you do not want"
plain += " to receive emails from us, click here: {$unsubscribe}"

api.campaigns.update(one_campaign.id, html=html, plain=plain)

Create /Delete a campaign

data = {"subject": "Regular campaign subject",
                   "groups": [2984475, 3237221],
                   "type": "regular"}
api.campaign.create(data)
api.campaign.delete(campaign_id=3971635)

count campaign

api.campaign.count()
api.campaign.count(status='draft')

Subscribers

Get all subscribers

api.subscribers.all()
api.subscribers.all(stype='active')
api.subscribers.active()

Get one subscriber

api.subscribers.get(email='demo@mailerlite.com')
api.subscriber.get(id=1343965485)

search

api.subscriber.search(search='demo@mailerlite.com')

subscribers groups

api.subscriber.groups(id=1343965485)

subscribers activity

subscriber.activity(id='1343965485')

Create subscriber

data = {'name': 'John',
        'email': 'demo-678@mailerlite.com',
        'fields': {'company': 'MailerLite'}
        }
api.subscriber.create(data)

Groups

Need documentation...

Segments

Get list of Segments.
api.segments.all()
Get countof Segments.
api.segments.count()

Fields

Get list of Fields.
api.fields.all()
Get one Field
api.fields.get(field_id=123456)
Create/update/delete one Field
api.fields.create(title="my custom title")
api.fields.update(field_id=123456, title="my new title 2")
api.fields.delete(field_id=123456)

Webhooks

Get list of Webhooks.
api.webhooks.all()
Get one webhook
api.webhooks.get(webhook_id=123456)
Create/update/delete one webhook
api.webhooks.create(url="https://yoursite/script-is-here",
	                event="subscriber.create")
api.webhooks.update(webhook_id=123456,
                    url="https://yoursite/script-is-here",
	                event="subscriber.create")
api.webhooks.delete(webhook_id=123456)

Account

# Get some info or stats
api.account.info()
api.account.stats()
api.account.double_optin()
# Set up the double_optin
api.account.set_double_optin(True)

Batch

batch_requests = {"requests": [{"method":"GET",
                                "path": "/api/v2/groups"
                                },
                                {"method":"POST",
                                    "path": "/api/v2/groups",
                                "body": {"name": "New group"}
                                }
                                ]
                   }
api.batch(batch_requests)

Contribute

We love contributions!

You've discovered a bug or something else you want to change - excellent! Create an issue!

You've worked out a way to fix it – even better! Submit a Pull Request!

Start with the contributing guide!

License

Project under 3-clause BSD license, more informations here

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mailerlite-api-python, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size mailerlite_api_python-0.1.0-py3-none-any.whl (21.9 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size mailerlite-api-python-0.1.0.tar.gz (38.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page