API Overview

Maropost for Marketing's API is based on the RESTful Framework. The extensive catalog of API methods allows System Developers to create/read/update/delete data within the platform.

Tips for Proper Usage

1. Access the API methods via HTTPS to take advantage of security inherent to this protocol.
2. Always include auth_token as a query string parameter — even for POST, PUT, and DELETE method calls.
3. The HTTP protocol is not designed for socket connections that remain open for extended periods of time. There is an inherent time out that all web servers observe.  For this reason, REST is not normally appropriate for retrieving vast amount of data out of Maropost for Marketing. Consider using Data Journeys for automated bulk data imports and exports instead.
4. Use the streaming API option to for bulk data retrieval that can only be obtained via API.

Create an API Authentication Token

1. Hover your cursor over your username and click 'Connections.'
2. Click the 'API Keys' tab to view a list of API authentication tokens.
3. Click the 'Add Keys' link on the page.
4. In the popup screen, enter a user-friendly name for the API key, and assign the access privileges accordingly.
5. Click the [Add] button. The API key will be generated and displayed on the screen.

Online API Guide

1. On the 'Connections' page, click the 'API Documentation' tab.
2. Click each of the tabs in the online guide to view specific details of each API method
   
   
   • Reports API – Methods in this API are used primarily to retrieve campaign response data for contacts within a date range regardless of which campaign has been sent.
     Methods also include those to retrieve aggregate delivery and response metrics for campaign reports, test reports, journey reports, and custom reports.
   • Contents API – View/create/edit/delete email content
   • Content Image API – Adds an image to the Image Library from an external source specified by the image’s file path URL.
   • Campaigns API – Create and send marketing promotional campaigns. Also, retrieve delivery and response metrics for a specified campaign.
   • Contacts API – Subscribe and unsubscribe contacts to email marketing lists; add/remove contact tags. View all information for a given contact including standard and custom fields, list subscriptions, journeys and product purchase history.
   • Tags API – Create/view/delete contact tags
   • Custom Fields API – Create/view/delete custom fields
   • Lists API – Create and delete lists, also view aggregate delivery and response metrics for campaigns sent to a given list.
   • Secure Lists API – Create and import a secure suppression list.
   • Do Not Mail List API – Add and remove a contact in the Do Not Mail list. Or, search if a contact is present in the Do Not Mail list.
   • Brands Do Not Mail List API – Add and remove a contact in a specific Brand Do Not Mail list. Search if a contact is present in a specific Brand Do Not Mail list.
   • Product/Revenue API – Add a contact’s purchase history data to the Product/Revenue database.
   • Workflows API – Legacy API methods that are scheduled to be removed at some point in the future. Please use the Journeys API. All new feature development will be done in the Journeys API.
   • Journeys API – Pause, restart, reset, and stop a contact’s flow through a journey.
   • Relational Tables API – Create/modify/delete/view the meta data of a relational table’s structure. This is not the API to use to add/view/edit/delete data within the tables themselves.  Instead, use the APIs for each relational table.
   • Transactional API – Create and send a transactional message. Includes the ability to include personalized content within the body of the transactional message.
   • Push Notifications API – Create and send a mobile app broadcast message. Also can create and send a transactional push notification.

Native Code Libraries

Maropost for Marketing also offers native code libraries in the web's most popular programming languages including:

• PHP
• Ruby
• NodeJS
• .NET