MailerLite Python SDK

Getting started

For more information about MailerLite API, please visit the following link:

Authentication

API keys are a quick way to implement machine-to-machine authentication without any direct inputs from a human beyond initial setup.

For more information how to obtain an API key visit the following link

Table of Contents

• MailerLite Python SDK
  • Getting started
    • Authentication
  • Table of Contents
  • Installation
  • Usage
    • MailerLite Client
    • Error handling
  • Subscribers
    • List all subscribers
    • Create a subscriber
    • Update a subscriber
    • Get a subscriber
    • Delete a subscriber
    • Forget a subscriber
  • Groups
    • List all groups
    • Create a group
    • Update a group
    • Delete a group
    • Get subscribers belonging to a group
    • Import bulk subscribers to a group
    • Assign subscriber to a group
    • Unassign subscriber from a group
  • Segments
    • List all segments
    • Update a segment
    • Delete a segment
    • Get segment information
    • Get subscribers belonging to a segment
  • Fields
    • List all fields
    • Create a field
    • Update a field
    • Delete a field
  • Automations
    • List all automations
    • Get an automation
    • Get subscribers activity for an automation
  • Campaigns
    • List all campaigns
    • Get a campaign
    • Create a campaign
    • Update a campaign
    • Schedule a campaign
    • Cancel a campaign
    • Delete a campaign
    • Get subscribers activity for a campaign
  • Forms
    • List all forms
    • Get a form
    • Update a form
    • Delete a form
    • Get subscribers who signed up to a specific form
  • Batching
    • Create a new batch
  • Webhooks
    • List all webhooks
    • Get a webhook
    • Create a webhook
    • Update a webhook
    • Delete a webhook
  • Timezones
    • Get a list of timezones
  • Campaign languages
    • Get a list of languages

Installation

Please run the following command:

python -m pip install mailerlite

Usage

MailerLite Client

The first thing that you need to do is to import mailerlite into your project and to instantiate the client by passing your API key:

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})

MailerLite API supports versioning, so you can pass additional argument to specify the API version:

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key',
'api_version': '2038-01-19'
})

Error handling

API responses with a 4xx or 5xx status code raise a requests.HTTPError exception. The exception includes the full response, so you can inspect the status code and error body:

importrequestsimportmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
try:
response=client.subscribers.get('some@email.com')
exceptrequests.HTTPErrorase:
print(e.response.status_code) # e.g. 404print(e.response.json()) # error body from the API

Network-level failures (DNS errors, connection resets, timeouts) raise the standard requests exceptions such as requests.ConnectionError and requests.Timeout. Catch requests.RequestException to handle both HTTP and network errors with a single handler.

Note: the batch endpoint (client.batch.request()) returns HTTP 200 even when individual sub-requests fail, so no exception is raised for them — check the per-request status codes in the returned body.

Upgrading from 0.1.x: methods that previously returned False or a raw status code on failure now raise requests.HTTPError instead. In particular, subscribers.delete() and subscribers.forget() used to return 204/200 and now return True on success.

Subscribers

List all subscribers

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
response=client.subscribers.list(limit=10, page=1, filter={'status': 'active'})

Create a subscriber

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
response=client.subscribers.create('some@email.com', fields={'name': 'John', 'last_name': 'Doe'}, ip_address='1.2.3.4', optin_ip='1.2.3.4')

Update a subscriber

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
response=client.subscribers.update('some@email.com', fields={'name': 'New', 'last_name': 'Name'}, ip_address='1.2.3.5', optin_ip='1.2.3.5')

Get a subscriber

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
response=client.subscribers.get('some@email.com')

Delete a subscriber

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
subscriber_id=1234567890response=client.subscribers.delete(subscriber_id)

Forget a subscriber

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
subscriber_id=1234567890response=client.subscribers.forget(subscriber_id)

Groups

List all groups

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
response=client.groups.list(limit=10, page=1, filter={'name': 'My'}, sort='name')

Create a group

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
group_name='My Group'response=client.groups.create(group_name)

Update a group

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
group_id=1234567group_name='My New Group'response=client.groups.update(group_id, group_name)

Delete a group

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
group_id=1234567response=client.groups.delete(group_id)

Get subscribers belonging to a group

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
group_id=1234567response=client.groups.get_group_subscribers(group_id, page=1, limit=10, filter={'status': 'active'})

Import bulk subscribers to a group

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
group_id=1234567subscribers= [
{'email': 'subscriber1@example.com', 'name': 'Subscriber One'},
{'email': 'subscriber2@example.com', 'name': 'Subscriber Two'},
]
response=client.groups.import_subscribers_to_group(group_id, subscribers)

Assign subscriber to a group

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
subscriber_id=111222group_id=1234567response=client.subscribers.assign_subscriber_to_group(subscriber_id, group_id)

Unassign subscriber from a group

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
subscriber_id=111222group_id=1234567response=client.subscribers.unassign_subscriber_from_group(subscriber_id, group_id)

Segments

List all segments

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
response=client.segments.list(limit=10, page=1)

Update a segment

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
segment_id=123456name="My New Segment Name"response=client.segments.update(segment_id, name)

Delete a segment

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
segment_id=123456response=client.segments.delete(segment_id)

Get segment information

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
segment_id=123456response=client.segments.get(segment_id, limit=10, filter={'status': 'active'})

Get subscribers belonging to a segment

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
segment_id=123456response=client.segments.get_subscribers(segment_id, limit=10, filter={'status': 'active'})

Fields

List all fields

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
response=client.fields.list(limit=10, page=1, sort='name', filter={'keyword': 'abc', 'type': 'text'})

Create a field

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
name='My Field'type= 'textresponse=client.fields.create(name, type)

Update a field

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
field_id=123456name='My New Field'response=client.fields.update(field_id, name)

Delete a field

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
field_id=123456response=client.fields.delete(field_id)

Automations

List all automations

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
response=client.automations.list(limit=10, page=1, filter={'enabled': True, 'name': 'some name', 'group': 123456})

Get an automation

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
automation_id=123456response=client.automations.get(automation_id)

Get subscribers activity for an automation

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
automation_id=123456response=client.automations.activity(automation_id, page=1, limit=10, filter={'status': 'active', 'date_from': '2022-12-20', 'date_to': '2022-12-31'})

Campaigns

List all campaigns

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
response=client.campaigns.list(limit=10, page=1, filter={'status': 'ready', 'type': 'regular'})

Get a campaign

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
campaign_id=123456response=client.campaigns.get(campaign_id)

Create a campaign

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
params= {
"name": "Test Campaign",
"language_id": 1,
"type": "regular",
"emails": [{
"subject": "This is a test campaign",
"from_name": "Test Man",
"from": "testuser@mailerlite.com",
"content": "Hi there, this is a test campaign!"
}]
}
response=client.campaigns.create(params)

Update a campaign

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
campaign_id=123456params= {
"name": "New Campaign Name",
"language_id": 2,
"emails": [{
"subject": "This is a test campaign",
"from_name": "Test Man",
"from": "testuser@mailerlite.com",
"content": "Hi there, this is a test campaign!"
}]
}
response=client.campaigns.update(campaign_id, params)

Schedule a campaign

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
campaign_id=123456params= {
"delivery": "scheduled",
"schedule": {
"date": "2022-12-31",
"hours": "22",
"minutes": "00"
}
}
response=client.campaigns.schedule(campaign_id, params)

Cancel a campaign

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
campaign_id=123456response=client.campaigns.cancel(campaign_id)

Delete a campaign

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
campaign_id=123456response=client.campaigns.delete(campaign_id)

Get subscribers activity for a campaign

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
campaign_id=123456response=client.campaigns.activity(campaign_id)

Forms

List all forms

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
response=client.forms.list(limit=10, page=1, sort='name', filter={'name': 'form name'})

Get a form

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
form_id=123456response=client.forms.get(form_id)

Update a form

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
form_id=123456name='New Form Name'response=client.forms.update(form_id, name)

Delete a form

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
form_id=123456response=client.forms.delete(form_id)

Get subscribers who signed up to a specific form

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
form_id=123456response=client.forms.get_subscribers(form_id, page=1, limit=10, filter={'status': 'active'})

Batching

Create a new batch

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
params= [
{"method": "GET", "path": "api/subscribers/list"},
{"method": "GET", "path": "api/campaigns/list"},
]
response=self.client.batches.request(params)

Webhooks

List all webhooks

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
response=client.webhooks.list()

Get a webhook

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
webhook_id=123456response=client.webhooks.get(webhook_id)

Create a webhook

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
events= [
'subscriber.created',
'subscriber.updated',
'subscriber.unsubscribed'
]
url='https://my-url.com'name='Webhook name'response=client.webhooks.create(events, url, name)

Update a webhook

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
webhook_id=123456events= [
'subscriber.created',
'subscriber.updated',
'subscriber.unsubscribed'
]
url='https://my-url.com'name='Webhook name'enabled=Falseresponse=client.webhooks.update(webhook_id, events, url, name, enabled)

Delete a webhook

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
webhook_id=123456response=client.webhooks.delete(webhook_id)

Timezones

Get a list of timezones

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
response=client.timezone.list()

Campaign languages

Get a list of languages

importmailerliteasMailerLiteclient=MailerLite.Client({
'api_key': 'your-api-key'
})
response=client.campaigns.languages()