This page lists all public Mapp Engage API methods grouped by resource, together with the API version from which each method is available. Use it to check the minimum API version required for a given method.
New in version 19: Address Attributes, Audit Log, Group Attributes, Member Attributes, Profile Attributes, Whiteboard, plus additional methods in the Segmentation resource. These resources and methods are available from API version 19.
Address Attributes
Method | Available from version |
|---|
list
| 19 |
Async
Method | Available from version |
|---|
getNextIndex
| 9 |
getPollCount
| 1 |
getSubmitCount
| 1 |
poll
| 1 |
pollByIndex
| 9 |
pollByRange
| 13 |
pollByType
| 13 |
submit
| 1 |
Audit Log
Method | Available from version |
|---|
events
| 19 |
Automation
Method | Available from version |
|---|
find
| 7 |
getDetails
| 7 |
runOnce
| 7 |
Blacklist
Method | Available from version |
|---|
createGroupEntries
| 4 |
createGroupEntriesHashed
| 9 |
createSystemEntries
| 4 |
createSystemEntriesHashed
| 9 |
deleteGroupEntries
| 4 |
deleteSystemEntries
| 4 |
CMS
Method | Available from version |
|---|
getMessageDefinitions
| 3 |
getMimeMessage
| 3 |
Method | Available from version |
|---|
anonymize
| 9 |
checkUpdateVersion
| 13 |
create
| 7 |
delete
| 7 |
export
| 9 |
get
| 7 |
update
| 7 |
updateMultichannelContact
| 1 |
Content
Method | Available from version |
|---|
delete
| 1 |
store
| 1 |
Draft Message
Method | Available from version |
|---|
create
| 6 |
delete
| 6 |
find
| 7 |
get
| 6 |
saveAsPreparedMessage
| 9 |
update
| 6 |
Ecommerce
Method | Available from version |
|---|
createAbandonedBrowseItem
| TBC |
createAbandonedCartItem
| 19 |
createWishlistItem
| 19 |
registerTransaction
| 19 |
removeAbandonedBrowseItem
| TBC |
removeAbandonedCartItem
| TBC |
removeTransaction
| TBC |
removeWishlistItem
| TBC |
Group
Method | Available from version |
|---|
activate
| 1 |
archive
| 1 |
clone
| 1 |
create
| 1 |
findIdsByAttributes
| 1 |
get
| 1 |
getAllGroupSettingsTemplates
| 1 |
getAttributes
| 1 |
getPreparedMessages
| 1 |
overrideGroupSettings
| 1 |
setAttributes
| 1 |
Group Attributes
Method | Available from version |
|---|
create
| 19 |
delete
| 19 |
export
| 19 |
get
| 19 |
importAttributes
| 19 |
list
| 19 |
update
| 19 |
validateName
| 19 |
Landing Page
Method | Available from version |
|---|
delete
| 2 |
deleteMany
| 2 |
find
| 2 |
getStatus
| 2 |
Member Attributes
Method | Available from version |
|---|
create
| 19 |
delete
| 19 |
get
| 19 |
list
| 19 |
update
| 19 |
validateName
| 19 |
Membership
Method | Available from version |
|---|
create
| 2 |
delete
| 2 |
findAll
| 2 |
findAllByEmail
| 2 |
get
| 7 |
getAttributes
| 2 |
getAttributesByEmail
| 2 |
getByEmail
| 7 |
replaceAttributes
| 2 |
subscribe
| 2 |
subscribeByEmail
| 2 |
unsubscribe
| 2 |
unsubscribeByEmail
| 5 |
unsubscribeFromMessage
| 5 |
unsubscribeFromMessageByEmail
| 5 |
updateAttributes
| 2 |
Message
Method | Available from version |
|---|
find
| 7 |
getHistorical
| 1 |
getManyUsedPersonalizations
| 1 |
getStatistics
| 5 |
getStatisticsByExternalMessageId
| 5 |
getTimeDistribution
| 7 |
getTimeDistributionByExternalMessageId
| 7 |
getUsedPersonalizations
| 1 |
sendSingle
| 1 |
sendTransactional
| 1 |
sendTransactionalWithEventDetails
| TBC |
validate
| 1 |
validateList
| TBC |
validateMany
| 1 |
Method | Available from version |
|---|
activateAttributeDefinitions
| 1 |
archiveAttributeDefinitions
| 1 |
attachTags
| TBC |
createAttributeDefinitions
| 1 |
createLinkCategories
| 1 |
deleteLinkCategory
| TBC |
detachTags
| TBC |
findByTags
| TBC |
getAttributeDefinitions
| 1 |
getLinkCategories
| TBC |
getTags
| TBC |
mergeAttributeDefinitions
| 1 |
updateLinkCategory
| TBC |
Mobile Push
Method | Available from version |
|---|
cancelPushSend
| 14 |
createAndSchedulePushMessage
| 14 |
deletePushMessage
| 14 |
getPushMessage
| 14 |
multiTenantSendSingle
| TBC |
pausePushSend
| 14 |
resumePushSend
| 14 |
sendSingle
| 14 |
updatePushMessage
| 14 |
Prepared Message
Method | Available from version |
|---|
find
| 7 |
get
| 14 |
send
| 9 |
update
| TBC |
Process
Method | Available from version |
|---|
applyAction
| 7 |
getDetails
| 7 |
getProcessList
| TBC |
Profile Attributes
Method | Available from version |
|---|
archive
| 19 |
create
| 19 |
export
| 19 |
get
| 19 |
getAvailableChannels
| 19 |
getCapacity
| 19 |
getMarked
| 19 |
getTechnical
| 19 |
list
| 19 |
markForStats
| 19 |
restore
| 19 |
unmarkForStats
| 19 |
update
| 19 |
validateName
| 19 |
Method | Available from version |
|---|
createRecord
| 4 |
deleteRecords
| 4 |
getRecordsByKey
| TBC |
updateRecords
| 4 |
Segmentation
Method | Available from version |
|---|
create
| 19 |
delete
| 19 |
find
| 19 |
get
| 19 |
getCount
| 15 |
preview
| 19 |
publish
| 19 |
schema
| 19 |
triggerCount
| 15 |
update
| 19 |
System
Method | Available from version |
|---|
getApiVersion
| 1 |
getEcmVersion
| 1 |
System User
Method | Available from version |
|---|
create
| 8 |
delete
| 8 |
get
| 8 |
update
| 8 |
updatePassword
| 9 |
Usage Statistics
Method | Available from version |
|---|
export
| 14 |
get
| 14 |
User
Method | Available from version |
|---|
create
| 1 |
delete
| 1 |
deleteByEmail
| 1 |
deleteByMobileNumber
| 7 |
get
| 1 |
getByEmail
| 1 |
getByIdentifier
| 4 |
getByMobileNumber
| 7 |
getMessageHistory
| 6 |
getProfile
| 1 |
getProfileByEmail
| 2 |
getProfileByMobileNumber
| 2 |
replaceProfile
| 2 |
replaceProfileByEmail
| 2 |
replaceProfileByMobileNumber
| 2 |
updateProfile
| 1 |
updateProfileByEmail
| 2 |
updateProfileByMobileNumber
| 7 |
Whiteboard
Method | Available from version |
|---|
delete
| 19 |
find
| 19 |
get
| 19 |
listTemplates
| 19 |
publish
| 19 |
save
| 19 |
schema
| 19 |
validate
| 19 |