# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mapp Engage public Mobile Push API
  version: 1.0.0
extends: openapi/mapp-mobile-push-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/mobilePush/cancelPushSend'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a scheduled push send
      effect: destructive
      questions:
      - How do I stop a push notification send that's already scheduled?
      - Can a push message sendout be cancelled for good?
      instructions:
      - text: Cancel the push send for message {messageId}.
        slots:
          messageId: query.messageId
      - text: Stop push message {messageId} from going out.
        slots:
          messageId: query.messageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mobilePush/createAndSchedulePushMessage'].post
  update:
    x-apievangelist-phrasing:
      intent: Create and schedule a push message
      effect: write
      questions:
      - 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?
      instructions:
      - text: Create and schedule a push titled Hello for my iOS app to the saved selection plan.
      - text: Schedule a new push message with this content and title.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mobilePush/deletePushMessage'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a prepared push message
      effect: destructive
      questions:
      - How do I delete a prepared push message I won't send?
      - Can a prepared push notification be removed?
      instructions:
      - text: Delete prepared push message {messageId}.
        slots:
          messageId: query.messageId
      - text: Remove push draft {messageId}.
        slots:
          messageId: query.messageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mobilePush/getPushMessage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a prepared push message
      effect: read
      questions:
      - What's in a prepared push message, such as its title and app?
      - Can I read back a push message's settings by ID?
      instructions:
      - text: Get prepared push message {messageId}.
        slots:
          messageId: query.messageId
      - text: Show the content of push message {messageId}.
        slots:
          messageId: query.messageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mobilePush/pausePushSend'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause a push send
      effect: write
      questions:
      - Can I temporarily halt a push notification sendout in progress?
      - Is there a way to pause a push message and pick it up later?
      instructions:
      - text: Pause the push send for message {messageId}.
        slots:
          messageId: query.messageId
      - text: Hold push message {messageId} for now.
        slots:
          messageId: query.messageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mobilePush/resumePushSend'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused push send
      effect: write
      questions:
      - How do I restart a push sendout I paused?
      - Can a paused push message continue sending?
      instructions:
      - text: Resume the push send for message {messageId}.
        slots:
          messageId: query.messageId
      - text: Continue sending paused push {messageId}.
        slots:
          messageId: query.messageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mobilePush/sendSingle'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a push to one recipient
      effect: write
      questions:
      - 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?
      instructions:
      - text: Send a push from campaign {campaignId} to recipient {recipientId}.
        slots:
          campaignId: query.campaignId
          recipientId: query.recipientId
      - text: Push campaign {campaignId} to user {recipientId} only.
        slots:
          campaignId: query.campaignId
          recipientId: query.recipientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mobilePush/multiTenantSendSingle'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a push personalized from child users
      effect: write
      questions:
      - Can I send one push notification personalized with child user data across tenants?
      - Which call handles multi-tenant single push sends?
      instructions:
      - text: Send a multi-tenant single push to this recipient with child user personalization.
      - text: Use the multi-tenant push to notify one recipient.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mobilePush/updatePushMessage'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a prepared push message
      effect: write
      questions:
      - 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?
      instructions:
      - text: Update prepared push message 1 with a new title and content.
      - text: Edit this push draft's selection plan and text.
      method: generated
      generated: '2026-09-26'