Mapp Marketing Cloud Mobile Push API

The Mobile Push API from Mapp Marketing Cloud — 9 operation(s) for mobile push.

Documentation GitHub OpenAPI

Business capability

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /mobilePush/cancelPushSend Cancel a scheduled push send · Cancel a push message send #

Ask an LLM

“How do I stop a push notification send that's already scheduled?”

“Can a push message sendout be cancelled for good?”

Tell an agent destructive · confirm first

Cancel the push send for message {messageId}.

Stop push message {messageId} from going out.

POST /mobilePush/createAndSchedulePushMessage Create and schedule a push message · Create and schedule a push message #

Ask an LLM

“Can I create a push notification for an app and schedule it in one call?”

“What fields go into a new scheduled push, like title, content and selection plan?”

Tell an agent

Create and schedule a push titled Hello for my iOS app to the saved selection plan.

Schedule a new push message with this content and title.

DELETE /mobilePush/deletePushMessage Delete a prepared push message · Delete a prepared push message #

Ask an LLM

“How do I delete a prepared push message I won't send?”

“Can a prepared push notification be removed?”

Tell an agent destructive · confirm first

Delete prepared push message {messageId}.

Remove push draft {messageId}.

GET /mobilePush/getPushMessage Get a prepared push message · Get a prepared push message #

Ask an LLM

“What's in a prepared push message, such as its title and app?”

“Can I read back a push message's settings by ID?”

Tell an agent

Get prepared push message {messageId}.

Show the content of push message {messageId}.

POST /mobilePush/pausePushSend Pause a push send · Pause a push message send #

Ask an LLM

“Can I temporarily halt a push notification sendout in progress?”

“Is there a way to pause a push message and pick it up later?”

Tell an agent

Pause the push send for message {messageId}.

Hold push message {messageId} for now.

POST /mobilePush/resumePushSend Resume a paused push send · Resume a push message send #

Ask an LLM

“How do I restart a push sendout I paused?”

“Can a paused push message continue sending?”

Tell an agent

Resume the push send for message {messageId}.

Continue sending paused push {messageId}.

POST /mobilePush/sendSingle Send a push to one recipient · Send a single mobile push message #

Ask an LLM

“Can I send a single mobile push notification to one recipient from a campaign?”

“What IDs do I need to push to one app user in Mapp Engage?”

Tell an agent

Send a push from campaign {campaignId} to recipient {recipientId}.

Push campaign {campaignId} to user {recipientId} only.

POST /mobilePush/multiTenantSendSingle Send a push personalized from child users · Send a single multi-tenant mobile push message #

Ask an LLM

“Can I send one push notification personalized with child user data across tenants?”

“Which call handles multi-tenant single push sends?”

Tell an agent

Send a multi-tenant single push to this recipient with child user personalization.

Use the multi-tenant push to notify one recipient.

PUT /mobilePush/updatePushMessage Update a prepared push message · Update a prepared push message #

Ask an LLM

“Can I change the title or content of a push message before it's sent?”

“What does updating a prepared push require, such as the message ID in the body?”

Tell an agent

Update prepared push message 1 with a new title and content.

Edit this push draft's selection plan and text.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/mapp:mapp-mobile-push-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Mapp Engage public Mobile Push API
  version: '1'
  description: 'Mapp Engage REST API (REST 2.0, incremental version v19). Assembled verbatim from the per-operation OpenAPI fragments Mapp publishes on each endpoint page of https://docs.mapp.com/apidocs/. The base URL is tenant-specific: take your Mapp Engage login host and append /api/rest/v19.'
  contact:
    name: Mapp Technical Support
    url: https://mapp.com/tech-support/
servers:
- url: /api/rest/v19
security:
- basicAuth: []
tags:
- name: Mobile Push
paths:
  /mobilePush/cancelPushSend:
    post:
      tags:
      - Mobile Push
      summary: Cancel a push message send
      description: Cancel message send.
      operationId: cancelPushSend
      parameters:
      - name: messageId
        in: query
        description: The message ID.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: ''
        '400':
          description: One of the parameters is invalid / The message ID or user ID cannot be found. / An unexpected backend error occurred.
        '404':
          description: 'Error response: {<br>"errorActor": "CLIENT",<br>"errorCode": "INVALID_REQUEST",<br>"message": "Not Found"<br>}'
  /mobilePush/createAndSchedulePushMessage:
    post:
      tags:
      - Mobile Push
      summary: Create and schedule a push message
      description: 'Create and schedule push message.

        Request body example:


        {

        "name" : "test name",

        "appId" : "1585031493269",

        "selectionPlanId" : "768E488C-45C2-4A6F-800B-C569586F1DC5",

        "content" : "This is iOS test push ",

        "messageTitle" : "Hello",

        "description" : "description",

        "notificationSound" : "sound1.mp3",

        "pushActionType" : "LAUNCH_APP",

        "pushActionParams" : "www.test.com",

        "buttonCategory" : "apx_read_open",

        "buttonActionType" : "OPEN_LANDING_PAGE",

        "buttonActionParams" : "https://www.google.com/",

        "mediaType" : "IMAGE",

        "mediaUrl" : "https://staging11.shortest-route.com/qatest/imgproxy/img/110/5ac68ca5498a5.png",

        "scheduledTime" : "2020-07-31T12:44:46.966Z",

        "timeZone" : "Europe/Budapest",

        "messagePriority" : "normal",

        "archiveOnCompleted" : "true"

        }


        Another example:


        {

        "name" : "test Silvia3",

        "appId" : "207084",

        "selectionPlanId" : "D5398D44-73C8-4B1E-8E99-711BC9CAEBB8",

        "content": "yo yo yo 😎",

        "messageTitle": "hello 😁",

        "notificationSound": "",

        "pushActionType": "LAUNCH_APP",

        "buttonLanguageCode": "en",

        "scheduledTime" : "2024-08-31T12:44:46.966Z",

        "timeZone" : "Europe/Rome",

        "messagePriority" : "high",

        "archiveOnCompleted" : "false"

        }


        Required parameters: name, appId, content, messageTitle


        pushActionType enum values [LAUNCH_APP, OPEN_LANDING_PAGE, OPEN_DEEP_LINK, OPEN_STORE]

        buttonCategory enum values [apx_yes_no_open, apx_acc_dec_open, apx_buy_open, apx_read_open]

        buttonActionType enum values [LAUNCH_APP, OPEN_LANDING_PAGE, OPEN_DEEP_LINK, OPEN_STORE]

        mediaType enum values [IMAGE, VIDEO]


        IMPORTANT: messagePriority (optional) - Please note that this feature is not activated by default. Please contact your Customer Success Manager to request activation.'
      operationId: createAndSchedulePushMessage
      responses:
        '200':
          description: 'Example response: <br>{<br>    "status" : "success",<br>    "messageId" : 1,<br>}'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PushMessageResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/PushMessageResponse'
        '400':
          description: ''
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PushMessage'
        description: An object that contains a definition of the push message to be created.
        required: true
  /mobilePush/deletePushMessage:
    delete:
      tags:
      - Mobile Push
      summary: Delete a prepared push message
      description: Delete prepared push message.
      operationId: deletePushMessage
      parameters:
      - name: messageId
        in: query
        description: The campaign ID of the prepared message to be deleted.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: ''
        '400':
          description: One of the parameters is invalid / The message ID or user ID cannot be found. / An unexpected backend error occurred.
        '404':
          description: 'Error response: {<br>"errorActor": "CLIENT",<br>"errorCode": "INVALID_REQUEST",<br>"message": "Not Found"<br>}'
  /mobilePush/getPushMessage:
    get:
      tags:
      - Mobile Push
      summary: Get a prepared push message
      description: Get push message.
      operationId: getPushMessage
      parameters:
      - name: messageId
        in: query
        description: The message ID.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: 'Example response: <br>{<br>    "messageId" : 1,<br>    "status" : "COMPLETED"<br>    "owner" : {<br>        "firstName" : "Radmila",<br>        "lastName" : "Petrovic",<br>        "email" : "radmila.petrovic@mapp.com"<br>    },<br>    "lastModified" : "2020-07-31T12:44:46.966Z",<br>    "name" : "test name",<br>    "appId" : "1585031493269",<br>    "selectionPlanId" : "768E488C-45C2-4A6F-800B-C569586F1DC5",<br>    "content" : "This is iOS test push ",<br>    "messageTitle" : "Hello",<br>    "description" : "description",<br>    "notificationSound" : "sound1.mp3",<br>    "pushActionType" : "LAUNCH_APP",<br>    "pushActionParams" : "www.test.com",<br>    "buttonCategory" : "apx_read_open",<br>    "buttonActionType" : "OPEN_LANDING_PAGE",<br>    "buttonActionParams" : "https://www.google.com/",<br>    "mediaType" : "IMAGE", - optional<br>    "mediaUrl" : "https://staging11.shortest-route.com/qatest/imgproxy/img/110/5ac68ca5498a5.png",<br>    "scheduledTime" : "2020-07-31T12:44:46.966Z",<br>    "timeZone" : "Europe/Budapest"<br>    "messagePriority" : "HIGH"<br>}'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PushMessage'
            application/xml:
              schema:
                $ref: '#/components/schemas/PushMessage'
        '400':
          description: One of the parameters is invalid / The message ID or user ID cannot be found. / An unexpected backend error occurred.
        '404':
          description: 'Error response: {<br>"errorActor": "CLIENT",<br>"errorCode": "INVALID_REQUEST",<br>"message": "Not Found"<br>}'
  /mobilePush/pausePushSend:
    post:
      tags:
      - Mobile Push
      summary: Pause a push message send
      description: Pause message send.
      operationId: pausePushSend
      parameters:
      - name: messageId
        in: query
        description: The message ID.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: ''
        '400':
          description: One of the parameters is invalid / The message ID or user ID cannot be found. / An unexpected backend error occurred.
        '404':
          description: 'Error response: {<br>"errorActor": "CLIENT",<br>"errorCode": "INVALID_REQUEST",<br>"message": "Not Found"<br>}'
  /mobilePush/resumePushSend:
    post:
      tags:
      - Mobile Push
      summary: Resume a push message send
      description: Resume message send.
      operationId: resumePushSend
      parameters:
      - name: messageId
        in: query
        description: The message ID.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: ''
        '400':
          description: One of the parameters is invalid / The message ID or user ID cannot be found. / An unexpected backend error occurred.
        '404':
          description: 'Error response: {<br>"errorActor": "CLIENT",<br>"errorCode": "INVALID_REQUEST",<br>"message": "Not Found"<br>}'
  /mobilePush/sendSingle:
    post:
      tags:
      - Mobile Push
      summary: Send a single mobile push message
      description: Sends single mobile push message to the specified recipient.
      operationId: SendSingleMobilePush
      parameters:
      - name: recipientId
        in: query
        description: The user ID of the intended message recipient.
        required: true
        schema:
          type: integer
          format: int64
      - name: campaignId
        in: query
        description: The campaign ID of the prepared message to be sent.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: ''
        '400':
          description: One of the parameters is invalid / The message ID or user ID cannot be found. / An unexpected backend error occurred.
        '404':
          description: 'Error response: {<br>"errorActor": "CLIENT",<br>"errorCode": "INVALID_REQUEST",<br>"message": "Not Found"<br>}'
  /mobilePush/multiTenantSendSingle:
    post:
      tags:
      - Mobile Push
      summary: Send a single multi-tenant mobile push message
      description: Sends single mobile push message to the specified recipient with child users personalization.
      operationId: MultiTenantSendSingleMobilePush
      responses:
        '204':
          description: ''
        '400':
          description: One of the parameters is invalid / The message ID or user ID cannot be found. / An unexpected backend error occurred.
        '404':
          description: 'Error response: {<br>"errorActor": "CLIENT",<br>"errorCode": "INVALID_REQUEST",<br>"message": "Not Found"<br>}'
  /mobilePush/updatePushMessage:
    put:
      tags:
      - Mobile Push
      summary: Update a prepared push message
      description: 'Update prepared push message.

        Request body example:


        {

        "messageId" : 1

        "name" : "test name",

        "appId" : "1585031493269",

        "selectionPlanId" : "768E488C-45C2-4A6F-800B-C569586F1DC5",

        "content" : "This is iOS test push ",

        "messageTitle" : "Hello",

        "description" : "description",

        "notificationSound" : "sound1.mp3",

        "pushActionType" : "LAUNCH_APP",

        "pushActionParams" : "www.test.com",

        "buttonCategory" : "apx_read_open",

        "buttonActionType" : "OPEN_LANDING_PAGE",

        "buttonActionParams" : "https://www.google.com/",

        "mediaType" : "IMAGE", - optional

        "mediaUrl" : "https://staging11.shortest-route.com/qatest/imgproxy/img/110/5ac68ca5498a5.png",

        "scheduledTime" : "2020-07-31T12:44:46.966Z",

        "timeZone" : "Europe/Budapest"

        "messagePriority" : "high"

        }


        Required parameters: messageId, name, appId, content, messageTitle


        pushActionType enum values [LAUNCH_APP, OPEN_LANDING_PAGE, OPEN_DEEP_LINK, OPEN_STORE]

        buttonCategory enum values [apx_yes_no_open, apx_acc_dec_open, apx_buy_open, apx_read_open]

        buttonActionType enum values [LAUNCH_APP, OPEN_LANDING_PAGE, OPEN_DEEP_LINK, OPEN_STORE]

        mediaType enum values [IMAGE, VIDEO]


        IMPORTANT: messagePriority (optional) - Please note that this feature is not activated by default. Please contact your Customer Success Manager to request activation.'
      operationId: updatePushMessage
      responses:
        '200':
          description: 'Example response: <br>{<br>    "messageId": 1,<br>    "messageStatus": "SCHEDULED"<br>}'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PushMessageResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/PushMessageResponse'
        '400':
          description: (PushCampaign with messageId=<id> does not exist)
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PushMessage'
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with a Mapp Engage system user of type API (or Hybrid).
x-apievangelist-provenance:
  method: searched
  generated: '2026-08-12'
  source: https://docs.mapp.com/apidocs/ (per-endpoint OpenAPI fragments)
  note: Union of the OpenAPI JSON fragments Mapp publishes on each endpoint page. Mapp does not serve one consolidated document at a public URL; the tenant-served Swagger lives at https://<your-engage-host>/apidoc/swagger.json and requires a tenant. Operation bodies, parameters, responses, tags, summaries and descriptions are verbatim from Mapp. The swagger/basePath/schemes/securityDefinitions envelope is added by API Evangelist from the published Getting Started guide; no operation content was authored.
  duplicate_operation_ids_suffixed: 30

Mapp Marketing Cloud Mobile Push API

Operations 9

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification