Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 45 Next »

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.

 Click here to expand and learn what you can do with REST API

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...

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 messages#Emailmessages

Send a message to a List
Send a message to a Group
Send a message to a Recipient

See Email messages#SendEmailMessages

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

  1. Read about Best practices to understand what you can do and learn the recommended approaches
  2. Download Demo Client choosing between several available languages.
  3. Test Resource Access with your MailUp account* 
  4. 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)

Related resources

  • No labels