How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Mapp Marketing Cloud

Mapp Engage API

The Mapp Engage REST API (REST 2.0, incremental version v19) exchanges data between external systems and Mapp Engage: create and update contacts, manage group memberships and attributes, send single, transactional and prepared messages, manage mobile push, build and publish segments and whiteboards, register e-commerce events (abandoned cart/browse, wish list, transactions), and retrieve Log Tracker audit events. Authentication is HTTP Basic with a system user of type API. The base URL is tenant-specific: your Engage login host plus /api/rest/v19.

Documentation Provider Profile APIs.io OpenAPI GitHub

Mapp Engage API is one of 4 APIs that Mapp Marketing Cloud publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Marketing Automation, Email, Messaging, Contacts, and Push Notifications. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and an API reference.

This API exposes 196 operations across 196 paths, organized into 28 resource areas. It is described by OpenAPI 2.0, at version 1.

Requests are made against the base URL https://{engage-host}/api/rest/v19.

196 operations 196 paths 0 schemas 16 DELETE80 GET95 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1
Base URL
https://{engage-host}/api/rest/v19
Authentication
basic
Contact
Mapp Technical Support
Resource Areas
28

Authentication & Security 1

Mapp Engage API declares 1 security scheme for authenticating requests. It defines a basic scheme (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication with a Mapp Engage system user of type API (or Hybrid).

Paths & Operations 196

Across 196 paths, the API surfaces 196 operations — 16 DELETE, 80 GET, 95 POST, 5 PUT. They span 28 resource areas, including Meta, Group, Contact, Process, Profile Attributes, Mobile Push, Draft Message, Group Attributes, and 20 more. Each is listed below with its method, path, parameters, and response codes.

Meta 13
POST
/meta/activateAttributeDefinitions
Activate attribute definitions
activateAttributeDefinitions 1 param → 204400
POST
/meta/archiveAttributeDefinitions
Archive attribute definitions
archiveAttributeDefinitions 1 param → 204400
POST
/meta/attachTags
Attach tags
attachTags 3 params → 204400
POST
/meta/createAttributeDefinitions
Create attribute definitions
createAttributeDefinitions 1 param → 204400
POST
/meta/createLinkCategories
Create link categories
createLinkCategories 1 param → 204400
POST
/meta/deleteLinkCategory
Delete a link category
deleteLinkCategory 1 param → 204400
POST
/meta/detachTags
Detach tags
detachTags 3 params → 200400
POST
/meta/findByTags
Find entities by tags
findByTags 2 params → 200400
GET
/meta/getAttributeDefinitions
Get attribute definitions
getAttributeDefinitions → 200400
GET
/meta/getLinkCategories
Get link categories
getLinkCategories → 200400
GET
/meta/getTags
Get tags
getTags 2 params → 200404
POST
/meta/mergeAttributeDefinitions
Merge attribute definitions
mergeAttributeDefinitions 1 param → 200400
POST
/meta/updateLinkCategory
Update a link category
updateLinkCategory 1 param → 204400
Group 11
POST
/group/activate
Activate groups
activate 1 param → 200204400
POST
/group/archive
Archive groups
archive 1 param → 200400
POST
/group/clone
Clone a group
clone 2 params → 200400
POST
/group/create
Create a group
CreateGroup 8 params → 200204400
POST
/group/findIdsByAttributes
Find group IDs by attributes
findIdsByAttributes 1 param → 200400
GET
/group/get
Get a group
GetGroup 1 param → 200400404
GET
/group/getAttributes
Get group attributes
getAttributes 1 param → 200400404
GET
/group/getAllGroupSettingsTemplates
List group settings templates
getAllGroupSettingsTemplates → 200400
GET
/group/getPreparedMessages
List prepared messages for a group
getPreparedMessages 1 param → 200400404
POST
/group/overrideGroupSettings
Override group settings
GroupOverrideGroupSettings 2 params → 204400
POST
/group/setAttributes
Set group attributes
setAttributes 2 params → 204400
Contact 8
GET
/contact/anonymize
Anonymize a contact
anonymize 2 params → 200400404
GET
/contact/checkUpdateVersion
Check contact update version
checkUpdateVersion 2 params → 200400
POST
/contact/create
Create a contact
create 1 param → 200400
POST
/contact/delete
Delete a contact
delete 1 param → 200400
GET
/contact/export
Export a contact (GDPR)
export 2 params → 200400404
POST
/contact/get
Get a contact
get 1 param → 200400403
POST
/contact/update
Update a contact
update 2 params → 200400
POST
/contact/updateMultichannelContact
Update a multichannel contact
updateMultichannelContact 2 params → 200400
Process 3
POST
/process/applyAction
Apply an action to a process
applyAction 2 params → 200400
GET
/process/getDetails
Get process details
getProcessDetails 1 param → 200400
GET
/process/getProcessList
List processes
getProcessList 3 params → 200400
Profile Attributes 14
POST
/profileAttributes/archive
Archive profile attributes
archive_2 → default
POST
/profileAttributes/create
Create a profile attribute
create_4 1 param → 200
GET
/profileAttributes/get
Get a single profile attribute by ID
get_5 1 param → 200404
GET
/profileAttributes/getAvailableChannels
Get available channels for attribute assignment
getAvailableChannels → 200
GET
/profileAttributes/getMarked
Get recipient statistic settings
getMarked → 200
GET
/profileAttributes/getCapacity
Get remaining profile attribute capacity per data type
getCapacity → 200
GET
/profileAttributes/getTechnical
Get technical (system) attributes
getTechnical → 200
GET
/profileAttributes/list
List profile attributes
list_4 2 params → 200
POST
/profileAttributes/markForStats
Mark a profile attribute for recipient statistics
markForStats 1 param → default
POST
/profileAttributes/restore
Restore archived profile attributes
restore → default
GET
/profileAttributes/export
Trigger async CSV export of profile attributes
export_3 → 200
POST
/profileAttributes/unmarkForStats
Unmark a profile attribute from recipient statistics
unmarkForStats 1 param → default
PUT
/profileAttributes/update
Update a profile attribute
update_4 2 params → 200
GET
/profileAttributes/validateName
Validate profile attribute name uniqueness
validateName_3 1 param → 200
Mobile Push 9
POST
/mobilePush/cancelPushSend
Cancel a push message send
cancelPushSend 1 param → 204400404
POST
/mobilePush/createAndSchedulePushMessage
Create and schedule a push message
createAndSchedulePushMessage 1 param → 200400
DELETE
/mobilePush/deletePushMessage
Delete a prepared push message
deletePushMessage 1 param → 204400404
GET
/mobilePush/getPushMessage
Get a prepared push message
getPushMessage 1 param → 200400404
POST
/mobilePush/pausePushSend
Pause a push message send
pausePushSend 1 param → 204400404
POST
/mobilePush/resumePushSend
Resume a push message send
resumePushSend 1 param → 204400404
POST
/mobilePush/sendSingle
Send a single mobile push message
SendSingleMobilePush 2 params → 204400404
POST
/mobilePush/multiTenantSendSingle
Send a single multi-tenant mobile push message
MultiTenantSendSingleMobilePush → 204400404
PUT
/mobilePush/updatePushMessage
Update a prepared push message
updatePushMessage 1 param → 200400
Draft Message 6
POST
/draftmessage/create
Create a draft message
CreateDraftMessage 1 param → 200400
DELETE
/draftmessage/delete
Delete a draft message
DeleteDraftMessage 1 param → 204404
POST
/draftmessage/find
Find draft messages
FindDraftMessage 1 param → 200400
GET
/draftmessage/get
Get a draft message
GetDraftMessage 1 param → 200400404
GET
/draftmessage/saveAsPreparedMessage
Save a draft message as a prepared message
saveAsPreparedMessage 4 params → 200204400
POST
/draftmessage/update
Update a draft message
UpdateDraftMessage 1 param → 200400
Group Attributes 8
POST
/groupAttributes/create
Create a group attribute
create_2 2 params → 200
POST
/groupAttributes/delete
Delete group attributes by name (bulk)
delete_4 1 param → default
GET
/groupAttributes/get
Get a single group attribute by name
get_3 2 params → 200404
POST
/groupAttributes/importAttributes
Import group attributes from CSV
importAttributes 2 params → 200
GET
/groupAttributes/list
List group attributes for a group
list_2 1 param → 200
GET
/groupAttributes/export
Trigger async CSV export of group attributes
export_2 1 param → 200
PUT
/groupAttributes/update
Update a group attribute
update_2 2 params → 200
GET
/groupAttributes/validateName
Validate group attribute name uniqueness within a group
validateName 2 params → 200
Member Attributes 6
POST
/memberAttributes/create
Create a member attribute for a group
create_3 2 params → 200
DELETE
/memberAttributes/delete
Delete a member attribute from a group
delete_2 2 params → default
GET
/memberAttributes/get
Get a single member attribute
get_4 2 params → 200404
GET
/memberAttributes/list
List member attributes for a group
list_3 1 param → 200
PUT
/memberAttributes/update
Update a member attribute for a group
update_3 2 params → 200
GET
/memberAttributes/validateName
Validate member attribute name uniqueness within a group
validateName_2 2 params → 200
Membership 16
GET
/membership/create
Create a membership
CreateMembership 2 params → 200400404
DELETE
/membership/delete
Delete a membership
DeleteMembership 2 params → 204400404
GET
/membership/findAllByEmail
Find all memberships for a user by email
findAllByEmail 1 param → 200400
GET
/membership/findAll
Find all memberships for a user
findAll 1 param → 200400404
GET
/membership/getByEmail
Get a membership by email
getByEmail 2 params → 200400
GET
/membership/get
Get a membership
GetMembership 2 params → 200400404
GET
/membership/getAttributesByEmail
Get membership attributes by email
getAttributesByEmail 2 params → 200400404
GET
/membership/getAttributes
Get membership attributes
GetMembershipAttributes 2 params → 200400404
POST
/membership/replaceAttributes
Replace membership attributes
replaceAttributes 3 params → 200400404
POST
/membership/subscribeByEmail
Subscribe a contact to a group by email
subscribeByEmail 3 params → 204400404
POST
/membership/subscribe
Subscribe a user to a group
subscribe 3 params → 204400404
POST
/membership/unsubscribeByEmail
Unsubscribe a contact from a group by email
unsubscribeByEmail 2 params → 204400
POST
/membership/unsubscribeFromMessageByEmail
Unsubscribe a contact from a message by email
unsubscribeFromMessageByEmail 3 params → 204400404
POST
/membership/unsubscribe
Unsubscribe a user from a group
unsubscribe 3 params → 204400404
POST
/membership/unsubscribeFromMessage
Unsubscribe a user from a message
unsubscribeFromMessage 3 params → 204400404
POST
/membership/updateAttributes
Update membership attributes
updateAttributes 3 params → 200400404
Related Data 4
POST
/relatedData/createRecord
Create a related data record
createRecord 1 param → 200400
POST
/relatedData/deleteRecords
Delete related data records
deleteRecords 1 param → 200400
GET
/relatedData/getRecordsByKey
Get related data records by key
getRecordsByKey 2 params → 200400
POST
/relatedData/updateRecords
Update related data records
updateRecords 1 param → 200400
Segmentation 10
POST
/segmentation/create
Create a selection plan
create_5 1 param → 200400
DELETE
/segmentation/delete
Delete a selection plan
delete_3 1 param → 200400
POST
/segmentation/find
Find selection plans
find_2 1 param → 200400
GET
/segmentation/getCount
Get a segment count
getCount 1 param → 200400
GET
/segmentation/get
Get a selection plan
get_2 1 param → 200400
GET
/segmentation/schema
Get the selection plan schema
schema → 200400
GET
/segmentation/preview
Preview a selection plan
preview 1 param → 200400
POST
/segmentation/publish
Publish a selection plan
publish 3 params → 200400
POST
/segmentation/triggerCount
Trigger a segment count
triggerCount 1 param → 200400
PUT
/segmentation/update
Update a selection plan
update_5 2 params → 200400
System User 5
POST
/systemuser/create
Create a system user
createSystemUser 3 params → 200400
DELETE
/systemuser/delete
Delete a system user
deleteSystemUser 3 params → 204400
GET
/systemuser/get
Get a system user
getSystemUser 3 params → 200400404
POST
/systemuser/updatePassword
Update a system user's password
updatePassword 1 param → 200400
POST
/systemuser/update
Update a system user
updateSystemUser 1 param → 200400
User 18
POST
/user/create
Create a user
createUser 3 params → 200400
DELETE
/user/deleteByEmail
Delete a user by email
deleteByEmail 1 param → 204400
DELETE
/user/deleteByMobileNumber
Delete a user by mobile number
deleteByMobileNumber 1 param → 204400
DELETE
/user/delete
Delete a user
deleteUser 1 param → 204400404
GET
/user/getByEmail
Get a user by email
getUserByEmail 1 param → 200400
GET
/user/getByIdentifier
Get a user by identifier
getByIdentifier 1 param → 200400
GET
/user/getByMobileNumber
Get a user by mobile number
getByMobileNumber 1 param → 200400
GET
/user/getMessageHistory
Get a user's message history
getMessageHistory 3 params → 200400
GET
/user/getProfileByEmail
Get a user's profile by email
getProfileByEmail 1 param → 200400
GET
/user/getProfileByMobileNumber
Get a user's profile by mobile number
getProfileByMobileNumber 1 param → 200400
GET
/user/getProfile
Get a user's profile
getProfile 1 param → 200400404
GET
/user/get
Get a user
getUser 1 param → 200400404
POST
/user/replaceProfileByEmail
Replace a user's profile by email
replaceProfileByEmail 2 params → 204400
POST
/user/replaceProfileByMobileNumber
Replace a user's profile by mobile number
replaceProfileByMobileNumber 2 params → 204400
POST
/user/replaceProfile
Replace a user's profile
replaceProfile 2 params → 204400404
POST
/user/updateProfileByEmail
Update a user's profile by email
updateProfileByEmail 2 params → 204400
POST
/user/updateProfileByMobileNumber
Update a user's profile by mobile number
updateProfileByMobileNumber 2 params → 204400
POST
/user/updateProfile
Update a user's profile
updateProfile 2 params → 204400404
Ecommerce 8
POST
/ecommerce/createWishlistItem
Create a wish list item
createWishlistItem 2 params → 200400
POST
/ecommerce/createAbandonedBrowseItem
Create an abandoned browse item
createAbandonedBrowseItem 2 params → 200400
POST
/ecommerce/createAbandonedCartItem
Create an abandoned cart item
createAbandonedCartItem 2 params → 200400
DELETE
/ecommerce/removeTransaction
Delete a transaction
removeTransaction 2 params → 200400
DELETE
/ecommerce/removeWishlistItem
Delete a wish list item
removeWishlistItem 2 params → 200400
DELETE
/ecommerce/removeAbandonedBrowseItem
Delete an abandoned browse item
removeAbandonedBrowseItem 2 params → 200400
DELETE
/ecommerce/removeAbandonedCartItem
Delete an abandoned cart item
removeAbandonedCartItem 2 params → 200400
POST
/ecommerce/registerTransaction
Register a transaction
registerTransaction 2 params → 200400
Blacklist 6
POST
/blacklist/createGroupEntries
Create group blacklist entries
createGroupEntries 2 params → 200400
POST
/blacklist/createGroupEntriesHashed
Create hashed group blacklist entries
createGroupEntriesHashed 3 params → 200400
POST
/blacklist/createSystemEntriesHashed
Create hashed system blacklist entries
createSystemEntriesHashed 2 params → 200400
POST
/blacklist/createSystemEntries
Create system blacklist entries
createSystemEntries 1 param → 200400
POST
/blacklist/deleteGroupEntries
Delete group blacklist entries
deleteGroupEntries 2 params → 200400
POST
/blacklist/deleteSystemEntries
Delete system blacklist entries
deleteSystemEntries 1 param → 200400
Whiteboard 8
POST
/whiteboard/save
Creates or updates a whiteboard. Schema-validates the body against the whiteboard JSON Schema before delegating to the downstream save flow.
save 1 param → 200400
DELETE
/whiteboard/delete
Deletes a whiteboard by id. Removes per-user data, statistics and labels via the downstream service.
delete_5 1 param → 204400
POST
/whiteboard/publish
Publishes a whiteboard. Schema-validates the DiagramData JSON before delegating to the downstream publish flow.
publish_2 1 param → 200400
GET
/whiteboard/get
Returns a single whiteboard (all versions) by id.
get_6 1 param → 200400
GET
/whiteboard/listTemplates
Returns the active static whiteboard templates served by the Audience Interaction Planner service.
listTemplates → 200
GET
/whiteboard/find
Returns a paginated list of whiteboard summaries for the calling customer, optionally filtered by name / status and ordered by last update date.
find_3 5 params → 200400
GET
/whiteboard/schema
Returns the canonical whiteboard JSON Schema served by the Audience Interaction Planner service.
schema_2 → 200
POST
/whiteboard/validate
Validates a whiteboard. Runs the full model-level validation suite and returns a structured ValidationResult.
validate_2 1 param → 200400
Content 2
DELETE
/content/delete
Delete a content element
DeleteContent 1 param → 204400
POST
/content/store
Store a file in the Content Store
store 1 param → 200400
Landing Page 4
DELETE
/landingpage/delete
Delete a landing page
deleteLandingPage 1 param → 204400
POST
/landingpage/deleteMany
Delete multiple landing pages
deleteMany 1 param → 204400
POST
/landingpage/find
Find landing pages
FindLandingPage 1 param → 200400
GET
/landingpage/getStatus
Get a landing page's status
getStatus 1 param → 200400
Address Attributes 1
GET
/addressAttributes/list
List address attributes (read-only, from metadata service)
list → 200
Usage Statistics 2
GET
/usagestatistics/export
Export usage statistics
ExportGetUsageStatistics 5 params → 200400
GET
/usagestatistics/get
Get usage statistics
getUsageStatistics 3 params → 200400
Automation 3
POST
/automation/find
Find automations
find 1 param → 200400
POST
/automation/getDetails
Get automation details
getDetails 2 params → 200400
GET
/automation/runOnce
Run a time-based automation once
runOnce 1 param → 200400
Message 14
POST
/message/find
Find messages
FindMessage 1 param → 200400
GET
/message/getHistorical
Get historical message data
getHistorical 2 params → 200400
GET
/message/getStatisticsByExternalMessageId
Get message statistics by external ID
getStatisticsByExternalMessageId 1 param → 200400
GET
/message/getStatistics
Get message statistics
getStatistics 1 param → 200400
POST
/message/getTimeDistributionByExternalMessageId
Get message time distribution by external ID
getTimeDistributionByExternalMessageId 2 params → 200400
POST
/message/getTimeDistribution
Get message time distribution
getTimeDistribution 2 params → 200400
GET
/message/getUsedPersonalizations
Get used personalizations for a message
getUsedPersonalizations 1 param → 200400
POST
/message/getManyUsedPersonalizations
Get used personalizations for multiple messages
getManyUsedPersonalizations 1 param → 200400
POST
/message/sendSingle
Send a single message
sendSingle 4 params → 204400
POST
/message/sendTransactionalWithEventDetails
Send a transactional message with event details
sendTransactionalWithEventDetails 4 params → 204400
POST
/message/sendTransactional
Send a transactional message
sendTransactional 5 params → 204400
POST
/message/validateList
Validate a list of messages
validateList 1 param → 200400
GET
/message/validate
Validate a message
validate 1 param → 200400
POST
/message/validateMany
Validate many messages
validateMany 1 param → 200400
Prepared Message 4
POST
/preparedmessage/find
Find prepared messages
FindPreparedMessage 1 param → 200400
GET
/preparedmessage/get
Get a prepared message
GetPreparedMessage 2 params → 200400
GET
/preparedmessage/send
Send a prepared message
send 7 params → 200400
POST
/preparedmessage/update
Update a prepared message
UpdatePreparedMessage 1 param → 204400
CMS 2
GET
/cms/getMimeMessage
Get a CMS message as MIME
getMimeMessage 1 param → 200400
GET
/cms/getMessageDefinitions
List CMS message definitions
getMessageDefinitions → 200400
System 2
GET
/system/getApiVersion
Get the API version
getApiVersion → 200400
GET
/system/getEcmVersion
Get the Engage build version
getEcmVersion → 200400
Async 8
GET
/async/getNextIndex
Get the next result index for a topic
getNextIndex 1 param → 200400
GET
/async/getPollCount
Get the polled result count for a topic
getPollCount 1 param → 200400
GET
/async/getSubmitCount
Get the submitted job count for a topic
getSubmitCount → 200400
GET
/async/pollByType
Poll results for a topic by event type
pollByType 2 params → 200400
GET
/async/pollByIndex
Poll results for a topic by index
pollByIndex 3 params → 200400
GET
/async/pollByRange
Poll results for a topic within a time range
pollByRange 4 params → 200400
GET
/async/poll
Poll results for a topic
poll 2 params → 200400
GET
/async/submit
Submit an asynchronous job for a topic
submit → 200400
Audit Log 1
GET
/auditlog/events
List Log Tracker audit events
auditLogEvents 9 params → 200400403

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mapp-engage-openapi.yml Raw ↑

Other APIs Mapp Marketing Cloud publishes across the network.

Mapp Intelligence Analytics API
AE Profile APIs.io
Mapp Product Catalog Public API
AE Profile APIs.io
Mapp Fashion API
AE Profile APIs.io
#Marketing Automation#Email#Messaging#Contacts#Push Notifications
← Back to M APIs
API Details
ID
mapp:engage
Base URL
https://{engage-host}/api/rest/v19
Docs
https://docs.mapp.com/apidocs/engage-api
Provider
Mapp Marketing Cloud
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=engage&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/engage"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Mapp Engage API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.