Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Get started with the MailUp REST API

If you want to work get up and running quickly with the MailUp REST API, the first thing you should do is grab a wrapper.

You can choose between many of the most used programming language and this is probably the best way to start with MailUp REST API.

Download the demo client

Start downloading a code sample Download a simple client app called "MailUp Demo Client", which  is available in PHP, C#, VB.Net, Java, Javascript, Objective-C.

Some installation notes for each language are available on the download pages.

 

Info
titleFor Ruby developers

You may be interested in the MailUp RubyGem, which is based on MailUp REST API and handles all the resources described here.
Ruby developers may skip the rest of this page.

Get ready in 15 minutes

From sample code to your own app

You don't need to be neither an OAuth2 guru nor a MailUp expert to have your first application up and running in a very short time if you use our MailUp Demo Client

MailUp Demo Client is a working example that properly authenticates on the MailUp platform and easily allows easy access to MailUp resources. You'll probably need less than 15 minutes to have it up and running and use it to learn how to access to MailUp resources, then you should be ready to .

You can then build your own application by simply extending this the sample applicationcode.On the right and below you can see some screenshots of MailUp Demo Client.

Using the demo client app

sample
  • app starts,
you have to
  • press "Sign in to MailUp"
, then you'll
  • You will then be asked to
login

 

After a successful authentication, a token is then displayed on the client interface

Then you You can then run some of predefined examples example calls, or build your own calls and test them using the "Call Method" button.

In the picture that follow you can see how to create a group Group in MailUp list 1 List 1 (see the MailUp Glossary for details on Lists and Groups).

Tip
titleTroubleshooting
  • Authentication: the "Confirm" button is large but you have to click exactly over the word "Confirm" to proceed
  • Custom method call: inserting a path and pressing "Enter" does not work for applying your request, use "Call Method" button instead.
  • In case of errors, MailUp Demo Client displays only the error code, not the detailed error description
  • More Samples: click here  to learn more about how to how to access to MailUp resources and take advantage of the filtering and paging features