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.
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
The MailUp REST API gives you remote and flexible access to many of the features available in the MailUp admin console. For example...
Import recipients, get import status
Create, modify, delete a message
Send a message to a List
Retrieve details on sent messages
See Email Statistics
Request new free trial account
- Read about Best practices to understand what you can do and learn the recommended approaches
- 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
Building your 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 uses 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 the request header you can set the response format as JSON or XML
- The application keys used in the MailUp Demo Clients shall not be used in a production environment. Obtain your application keys by activating a free developer account.
- Each application is tied to a set of application keys (but not to a specific MailUp account: it can be used with any MailUp account)
Getting stuck while developing your application?
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
- Authentication (token has to be refreshed, please use available samples as guidelines)
- Wrong credentials (e.g. trying to access to your production console account with the credentials of your developer console account, or viceversa)
- Unexpected behavior of an API call that is due to unchecked error codes that were returned by previous API calls.
- Developers that unfamiliar with MailUp terminology (Resource Access section and related links should be helpful)