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 8 Next »

2014-10-14 Confirmed opt-in and scheduled sending added to Version 1.1

by MailUp Dev Team

  1. Performance improvement - API response time has been significantly reduced
  2. Added restriction - HTTP 403 error is returned if authenticated user has not yet accepted the MailUp "Terms of Service", which appears the first time the user signs in with the admin console account
  3. New features - version 1.1 has been extended with the following methods:
Confirmed opt-in for single subscriber
  • POST Console/List/{ListID}/Recipient?ConfirmEmail=true to add a new subscriber to the specified list with the "Confirmed Optin" option. Recipient is added as "pending" and a confirmation request email is automatically sent.
  • POST Console/Group/{GroupID}/Recipient?ConfirmEmail=true the same as above but in this case recipient either added to specified group and subscribed to the list that the specified group belongs to.

Confirmed opt-in for multiple subscribers

  • POST Console/List/{ListID}/Recipients?ConfirmEmail=true to add a list of subscribers to the specified list with the "Confirmed Optin" option. Recipients are added as "pending" and a confirmation request email is queued but not automatically sent
  • POST Console/Group/{GroupID}/Recipients?ConfirmEmail=true the same as above but in this case recipient either added to specified group and subscribed to the list that the specified group belongs to.
  • GET Console/Import/{id_import}/Sending: read the ID of the sending that has been created when adding recipients with "Confirmed Optin" option set as 'true'
  • POST Console/Email/Sendings/{id_Sending}/Immediate: perform immediate sending (i.e. send as soon as possible)
  • POST Console/Email/Sendings/{id_Sending}/Deferred: perform scheduled sending (i.e. send at specified date and time)

Bulk unsubscription

  • POST Console/List/{ListID}/Recipients?importType='asOptout' to "import as unsubscribed" a list of specified recipients. Unsubscribe applies also to recipients that were previously present as "subscribed" on MailUp console account

Queue management

  • GET Console/Email/Sendings/Immediate: Read from sending queue the list of email messages that are placed into the "immediate sending" queue.
  • GET Console/Email/Sendings/DeferredRead from sending queue the list of messages that have been scheduled.
  • GET Console/Email/Sendings/Undefined: Read from sending queue the list of messages that are neither scheduled nor added to "immediate sending" queue. 
  • GET Console/Email/Sending/{id_Sending}/Deferred: Retrieve the earliest date to schedule the given sending task.

Scheduled sending

  • POST Console/List/{id_List}/Email/{id_Message}/Send?datetime='1994-11-05T13:15:30Z' (use UTC time zone)


2013-10-10 Version 1.1 updates

by MailUp Dev Team

Version 1.1 has been updated with two new methods:
  • GET - Console/List/{id_List}/Recipient/{id_Recipient}/Groups: to retrieve the list of the groups in which the specified recipient has been subscribed
  • GET - Console/List/{id_List}/Archived/Emails: to get the list of the archived emails in the specified list

2013-10-10 Version 1.1 has been released

by MailUp Dev Team

Version 1.1 has been officially released (see change log) and BETA has been removed. Online documentation is now updated.

2013-07-25 Filtering and ordering coming in v1.1 

by MailUp Dev Team

How the REST API is evolving

We're already at work on a new version of the REST API.

Version 1.0 of the MailUp REST API is already being used in some integrations, including the MailUp App for Salesforce. We are still optimizing it for big volumes of data (this is the main reason for the BETA tag) and, at the same time, we are working to introduce additional filtering, paging, and ordering capabilities in version "1.1".

Some changes in the API related to these new features will affect backward compatibility, and therefore version 1.1 will be released with a different endpoint.

Expected release date for v1.1 is some time in September 2013. When version 1.1 is released:

  • The MailUp REST API will be OUT OF BETA for both versions 1.0 and 1.1
  • If you are using version 1.0, you will be able to continue using it
  • Migrating to v1.1 is recommended if you want to benefit from the new features

We don't expect that you will be frequently asked to switch endpoint: please consider this as a rare case that is due to the young age of the MailUp REST API project. Future improvements are expected to be applied to version 1.1 without backward compatibility problems.

New features in v1.1

Here is a list of new features that will be available in v1.1:

  • Get requests: all the HTTP GET requests that return a collection of items will have a total counter and pagination info alongside with the Items collection itself;
  • Default pagination values: all the requests that return a collection of items will be paginated by default with a page size of 20…no more entire collection by default,
  • Entire collection: if you want the entire collection you’ll have to setup a particular value for pageSize or pageNumber;
  • Ordering: with the new release it will be possible to specify complex ordering filters on multiple fields and - if needed - different sorting directions (ex. order by=” id, category-id desc; title asc ”)
  • Filtering: new complex query parser will be added to allow developers to filter collections “as they wish” (ex. filter by=”  [idColor==’Blue’ || idColor.Contains(‘Azure’)] && [id <= 30 && id != 10] ”)

2013-07-15 Documentation of REST API v1.0 officially released 

by MailUp Dev Team

The MailUp REST API documentation is now public.

  • No labels