Versions Compared

Key

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

...

The following is a list of frequently asked questions about the MailUp API

Table of Contents

...

 

Do you charge for use of the MailUp API?

...

No, there is no charge at this time. You must have a valid MailUp account, however, to send messages through MailUp (except when testing via a MailUp Developer Account or while using a MailUp Free Trial account).

Do I always need a Developer Account

You will need a Developer Account if you wish to use the MailUp REST API. That's because our REST API uses Oauth2 authentication, and therefore your "application" needs to be uniquely identified via API keys (which are provided to you when you create a Developer Account) and authorized to communicate with MailUp. Once the application has been authorized, user authentication is then handled via MailUp account credentials (i.e. the same application can be used by N different users).

If you are simply trying to quickly add a recipient to a List, check a recipient's subscription status, or update a subscriber profile, you can do so using these simple HTTP requests.

What is my List's GUID

It's a unique identifier for your List. The number identifier (e.g. List 4) is unique to your MailUp account, but not within the MailUp system. The GUID, instead, is unique within the entire MailUp system. You can find the GUID for your lists in the "Codes Table" within your MailUp admin console.

Can I use MailUp to send messages from an external application, without logging into the MailUp admin console?

Yes, see the section on sending messages through MailUp from another system (e.g. a Web site or other SaaS application).

I need to integrate my CRM with MailUp. How should I do?

We have developed two types of integrations, applicable to many systems such as SugarCRM, Salesforce, VTiger and others, which allow to update bidirectionally the user status (subscribed/unsubscribed) inside the CRM. Both types of integration require on your side some work for the development and integration with the CRM. The two ways to integrate are:

Batch FTPFTP-based integration

  • Pros: simple and easy
  • Cons: not in real time (updated once a day, typically during the night)
  • How it works: The database of contacts (full or diff), with status indication (subscribed/unsubscribed) and insertion in lists or groups (infinite groups can be created within a list) must be moved from the CRM to a FTP space. The status (subscribed/unsubscribed) is list-specific. MailUp generates the flow of statistics and unsubscriptions toward the CRM via batch FTP mode. Unsubscriptions could also be exported via API call to your public procedure, following specifications that you have provided.

SOAP or Get/Post APIsHTTP API Examples

...

There are many ways to do so.

  • You can use one of the existing plugins (e.g. Salesforce) or an integration "hub" like Zapier
  • You can use the MailUp Rest API and developer a full-featured integration between the two systems
  • You can use MailUp Webhooks to update the CRM in quasi real-time when something happens on the MailUp side.
  • You can request an automated FTP export and import data into your CRM.

My system requires a type of integration not included in this document. Can it be developed anyway?

Our technicians can analyze and evaluate any custom integration between MailUp and other external systems. We may be able to work with you to add features to MailUp that allow an integration with another system. If the requested development can be used by other customers, you may be eligible for a discount on the cost of such development.

Can I install MailUp in my server farm and personalize it?

Unfortunately this is not possible. Here are the two main reasons:

  1. MailUp's architecture consists of several frontend, backend, sql and sending servers, with redundant connections, to ensure the highest level of performance and reliability.
  2. The sending infrastructure is configured so that the sendings are distributed across several IPs, according to constantly changing rules and to the agreements with ISPs, that often also provide guidelines to be followed. We have also signed agreements with many important ISPs, so to allow whitelisting and to prevent messages from being blocked by antispam filters, even with high volumes of emails being sent. MailUp has also agreements in place with ISPs to handle feedback loops. This infrastructure, also connected to domain and DNS management (e.g. DKIM signatures) is hardly replicable externally, both because of its complexity and because it has to be constantly monitored and updated.

How do I create a subscription form that allows subscription to more than one list at the same time?

You can use our HTTP Get/Post API. See Subscribe.aspx.

XMLSubscribe.aspx can be also used, but in this case a confirmation email will be sent for each selected list. As an alternative, it is possible not to send the email, though we would not suggest this practice.

Is there a way to unsubscribe a user from all lists when he unsubscribes from one of them?

You need to activate a post-operation: after the unsubscription, MailUp can perform predefined actions, such as calling external procedures to update a record in a CRM or CMS system, or unsubscribe that user from other lists. The setup of post-operations is available free of charge. can do so by using the MailUp Webhooks.