README.md

Python Rest API Client

Python REST API integration/implementation samples

Requirements

• Python 3 and PIP installed
• A valid MailUp account ( trial accounts allowed )
• API application keys

notes :

• For further API information, please visit MailUp REST API Help
• For MailUp trial account activation please go to MailUp web site
• For further API application keys information please go to Get API application keys

How to run this project

• pip install -r ./requirements.txt
• python3 ./app.py

Samples overview

This project encloses a short list of pre definied samples describing some of the most common processes within MailUp.

• Sample 1 - Importing recipients into a new group
• Sample 2 - Unsubscribing a recipient from a group
• Sample 3 - Updating a recipient information
• Sample 4 - Creating a message from a custom template ( at least one template must be saved on list 1 )
• Sample 5 - Building a message with images and attachments
• Sample 6 - Tagging an email message
• Sample 7 - Sending an email message
• Sample 8 - Displaying statistics with regards to message created in sample 4 or 5 and/or sent out in sample 7

Before starting

After you get the MailUp account ID and the API application keys, please set them into your local config file. You can find the path of the config file here:

rest-samples-python/config.py      

Debugging tool

Notes

To learn more about API keys and how to get them, please refer to MailUp REST API Keys and endpoints

Revision history