# 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 Prepared Message API
  version: 1.0.0
extends: openapi/mapp-prepared-message-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: 4
- target: $.paths['/preparedmessage/find'].post
  update:
    x-apievangelist-phrasing:
      intent: Search prepared messages by date
      effect: read
      questions:
      - Which prepared messages were created or updated in the last month?
      - What's the maximum creation date range when searching prepared messages?
      instructions:
      - text: Find prepared messages matching {preparedMessageFilter}.
        slots:
          preparedMessageFilter: query.preparedMessageFilter
      - text: List prepared messages created in the last 31 days using {preparedMessageFilter}.
        slots:
          preparedMessageFilter: query.preparedMessageFilter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/preparedmessage/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview a prepared message for a contact
      effect: read
      questions:
      - Can I see a prepared message personalized for a specific contact?
      - What does the trackingOverride setting do on a prepared message?
      instructions:
      - text: Get prepared message {messageId} personalized for contact {contactId}.
        slots:
          messageId: query.messageId
          contactId: query.contactId
      - text: Preview message {messageId} as contact {contactId} would see it.
        slots:
          messageId: query.messageId
          contactId: query.contactId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/preparedmessage/send'].get
  update:
    x-apievangelist-phrasing:
      intent: Schedule a prepared message sendout
      effect: write
      questions:
      - Can I schedule a prepared message to go out at a set date and time?
      - How does best sendout time work when scheduling a prepared message?
      instructions:
      - text: Send {preparedMessageId} at {sendDateTime}, best time {bestSendoutTime}, fallback {bestSendoutTimeDefault}, zone {bestSendoutTimeTimezone}.
        slots:
          preparedMessageId: query.preparedMessageId
          sendDateTime: query.sendDateTime
          bestSendoutTime: query.bestSendoutTime
          bestSendoutTimeDefault: query.bestSendoutTimeDefault
          bestSendoutTimeTimezone: query.bestSendoutTimeTimezone
      - text: Schedule prepared message {preparedMessageId} for {sendDateTime} to selection {selectionId}.
        slots:
          preparedMessageId: query.preparedMessageId
          sendDateTime: query.sendDateTime
          selectionId: query.selectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/preparedmessage/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a prepared message
      effect: write
      questions:
      - Can I edit a prepared message's settings, including tracking override?
      - How do I force open and click tracking on a prepared message for all recipients?
      instructions:
      - text: Update this prepared message with trackingOverride set to 2.
      - text: Save changes to the prepared message's content.
      method: generated
      generated: '2026-09-26'