What is the Mapp Engage API?

An API (application programming interface) is used to share data between your information system and Mapp Engage. The Mapp Engage web services API connects any program to your marketing platform. You can use the API to send messages, update your blacklist, anonymize contacts, and much more!

We offer and support access via both SOAP (Simple Object Access Protocol) and REST(REpresentational State Transfer) APIs. There are some general differences; which one you use will depend on your preferences. If you have a large amount of data to send, you may wish to use Control XML (CXML). It is a SOAP document with an authentication header and a comprehensive body. In addition to the XML, large attachments with recipient lists can be uploaded.

What can I do with the Engage API?

Lots! For example, you can send messages and create or update contact profiles. Please see our Use Cases for ideas to get you started, or check out the Swagger for a complete list of available calls.

Watch this video for more details.

Swagger Documentation

Swagger (or OpenAPI) is a method of describing API methods that are exposed via our REST API in a standardized way in a block of JSON. This is similar to how the SOAP API is described using a block of XML in a WSDL file.

You can access Swagger by using the following link with your domain:  http://YOUR-DOMAIN/apidoc/swagger.json . This domain is the same as the one you use to log in to the Mapp Engage platform.

 


If you would like a more visual approach, we recommend using Swagger Editor. 

Related Topics