# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Iterable Push API
  version: 1.0.0
extends: openapi/iterable-push-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/api/push/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a push notification to a user
      effect: destructive
      questions:
      - Can I cancel a push notification scheduled for one user?
      - What do I need to identify a push I want to cancel?
      instructions:
      - text: Cancel the push from campaign {campaignId} to {email}.
        slots:
          campaignId: requestBody.campaignId
          email: requestBody.email
      - text: Cancel scheduled push {scheduledMessageId}.
        slots:
          scheduledMessageId: requestBody.scheduledMessageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/push/target'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a campaign push to a user
      effect: write
      questions:
      - Can I schedule a push to one user and attach metadata?
      - Do data fields I send override the user's profile fields in a push?
      instructions:
      - text: Send push campaign {campaignId} to {recipientEmail}.
        slots:
          campaignId: requestBody.campaignId
          recipientEmail: requestBody.recipientEmail
      - text: Push campaign {campaignId} to user {recipientUserId} at {sendAt}.
        slots:
          campaignId: requestBody.campaignId
          recipientUserId: requestBody.recipientUserId
          sendAt: requestBody.sendAt
      method: generated
      generated: '2026-10-01'
- target: $.paths['/push/target'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a push via the simple endpoint
      effect: write
      questions:
      - Is there a plain /push/target call that sends a templated push by email?
      - How do I send a personalized push using only an email and campaign?
      instructions:
      - text: Using /push/target, push campaign {campaignId} to {recipientEmail}.
        slots:
          campaignId: requestBody.campaignId
          recipientEmail: requestBody.recipientEmail
      - text: Send push campaign {campaignId} to {recipientEmail} with data {dataFields} via the simple endpoint.
        slots:
          campaignId: requestBody.campaignId
          recipientEmail: requestBody.recipientEmail
          dataFields: requestBody.dataFields
      method: generated
      generated: '2026-10-01'