API wrapper for MailerLite written in Python
Project description
mailerlite-python
mailerlite-python is an API wrapper for MailerLite, written in Python
Installing
pip install mailerlite-python
Usage
from mailerlite.client import Client
client = Client('API_KEY')
Subscribers
List Subscribers
subs = client.list_subscribers(params=None)
# Optional params (dict):
# filter[status] = Must be one of the possible statuses: active, unsubscribed, unconfirmed, bounced or junk.
# limit = Defaults to 25
# page = Defaults to 1
Create Subscriber
subscriber = {
"email": "carlos@burgos.com",
"fields": {
"name": "Carlos",
"last_name": "Burgos",
"city": "Bogotá",
}
}
sub = client.create_subscriber(subscriber)
# If user email already exists, updates existing subscriber.
Fetch Subscriber
# Reference can be either email or ID
subscriber = client.fetch_subscriber(reference)
Delete Subscriber
client.delete_subscriber(subscriber_id)
Subscribe Subscriber
client.activate_subscriber(subscriber_id)
Unsubscribe Subscriber
client.unsubscribe_subscriber(subscriber_id)
Assign Subscriber to a Group
client.assign_to_group(subscriber_id, group_id)
List Subscriber fields
fields = client.list_subscriber_fields()
List Groups
groups = client.list_groups(params=None)
# Optional params (dict):
# filter[name] = Returns partial matches
# limit = An account can have at most a 250 groups
# page = Defaults to 1
# sort = Can be one of: name, total, open_rate, click_rate, created_at. Defaults to ascending order; prepend (-)
Webhooks
List all webhooks
webhooks = client.list_webhooks()
Create webhook
webhook = {
"name": "first webhook",
"events": ["subscriber.created"],
"url": "http://www.cartwright.info/eligendi-soluta-corporis-in-quod-ullam"
}
webhook_created = client.create_webhook(webhook)
Delete webhook
client.delete_webhook(webhook_id)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file mailerlite_python-0.1.2.tar.gz
.
File metadata
- Download URL: mailerlite_python-0.1.2.tar.gz
- Upload date:
- Size: 3.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f88764cf1662753df030a2b27cd137ea33fe9f5d969c96e827823f0b682a8f7e |
|
MD5 | e8f834de8e8048ab1316cd7b698a64c8 |
|
BLAKE2b-256 | 4ee61e31d0711656dd45a5173b5a742b9114c59ab0b3ea44cf56c1a5e5f65511 |
File details
Details for the file mailerlite_python-0.1.2-py3-none-any.whl
.
File metadata
- Download URL: mailerlite_python-0.1.2-py3-none-any.whl
- Upload date:
- Size: 4.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c5448944ca885e2397877fcd089fd8998495e9ef5ccc3ca798fbb8f4c1f3be25 |
|
MD5 | 90045fc5fc15914b5378b54d33ed4809 |
|
BLAKE2b-256 | 10b470519551053116f340fdccbe90c5d5f5eea6fed421bce9f758f49d0ddf32 |