Documentation Index

Fetch the complete documentation index at: https://docs.mapp.com/llms.txt

Use this file to discover all available pages before exploring further.

Engage API

Updated
  • 1 minute(s) read
Prev Next

The Mapp Engage API lets you exchange data between your systems and Mapp Engage — send messages, create and update contacts, manage groups and segments, trigger automations, and more.

Interfaces

  • REST API (REST 2.0) — the current interface; use this for all new integrations.
  • SOAP API and Control XML — legacy interfaces, kept for existing integrations and large-volume data transfers.

API versions

Three terms appear across this documentation:

  • REST 2.0 — the current generation of the Engage REST API. New integrations should target REST 2.0.
  • v19 — the current incremental version within REST 2.0. Versions are additive: every prior version (v1–v19) keeps all earlier operations and only adds new ones. You can pin a version in the URL (e.g. /api/rest/v19/...).
  • API 1 — a separate, earlier generation, still in production for some workflows. It is not an old version of REST 2.0.

To check which version your tenant currently exposes, call GET /system/getApiVersion.

Getting started

See Getting Started for authentication, base URL, and required headers. Browse Endpoints for the full method reference and Objects & Types for the data structures. For ready-made examples, see Use Cases.