When to use the MailUp REST API
The MailUp REST API gives you access to a variety of methods to manage email campaigns, subscribe and unsubscribe recipients, and retrieving statistics, bounces, etc.
...
| title | Click here to expand and learn what you can do with REST API |
|---|
| Info |
|---|
Before choosing the REST API as the technical solution for integration with your application, ensure that you have read the section about the Best practices |
...
Getting started
Read our best practices to understand what you can do and learn the recommended approaches.
Download Demo Client and choose among several available programming languages.
Test Resource Access with your MailUp account. Don't have one? Request a developer account.
After getting acquainted with the API, get your API keys & build your own application.
Integrating your application
A few things to keep in mind:
The MailUp REST API uses Oauth2 and requires a token refresh. You can use the available samples to see how to refresh the authorization token
By properly setting the request header you can set the response format as JSON or XML
Each application is tied to a set of application keys, which are used to authorize the application (get yours).
- Users of the application will be authenticated using their own MailUp account credentials.
- The application keys used in the sample code shall not be used in a production environment.
| Tip | ||
|---|---|---|
| ||
Take another look at the "Getting Started" section: the demo client can help a lot. Also, before contacting us, please consider that most of the questions that we receive are about...
|
A complete email messaging API
When to use the MailUp REST APIThe MailUp REST API gives you access to a variety of methods to manage email campaigns, subscribe and unsubscribe recipients, and retrieving statistics, bounces, etc.
Recipient management | Message management | Campaign management | Statistics retrieval | Account provisioning |
|---|---|---|---|---|
Import recipients, get import status Retrieve lists, groups, email messages, etc. Subscribe, unsubscribe, update recipients Create and modify groups ... |
...
See Manage Lists and Groups and Recipients | Create, modify, delete a message Create a message from a template Retrieve a list of messages Add and remove images ... |
...
See Email |
...
Send a message to a List Send a message to a Group Send a message to a Recipient ... |
...
and also Transactional Emails | Retrieve details on sent messages Retrieve opens, clicks, bounces, unsubscribes Retrieve stats for the last N hours Retrieve stats for a specific period ... |
...
See Email Statistics | Request new free trial account Obtain request status ... |
...
See Accounts |
Getting Started
- Download Demo Client choosing between several available languages.
- Test Resource Access with your MailUp account*
- After getting acquainted with the API, get your own API keys and build your own application
(*) Don't have one? Request a developer account
Build your own application
When you have completed the "Getting Started" steps listed above you can start building your application. There are some things to know about MailUp REST API:
- MailUp REST API use Oauth2 and requires a token refresh. You can use the available samples as an example of the expected way to refresh the authorization token
- By properly setting request header you can set response format as JSON or XML
- Application keys of MailUp Demo Clients shall not be used in a production environment. Get your keys for free by activating an account
- An application is strongly related to a couple of application keys but it can be used for the integration with any MailUp console account
| Tip | ||
|---|---|---|
| ||
We assume that you are a developer and you have carefully read the "Getting Started" section. Before contacting us please consider that most of the questions that we receive are about
|
Related resources
...
| Info |
|---|
Before choosing the REST API as the technical solution for integrating your application, ensure that you have read our best practices. |