# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Iterable Email API
  version: 1.0.0
extends: openapi/iterable-email-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: 4
- target: $.paths['/api/email/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a scheduled email to a user
      effect: destructive
      questions:
      - Can I cancel an email that's scheduled for a specific user?
      - What do I need to identify the email I want to cancel?
      instructions:
      - text: Cancel the email from campaign {campaignId} to {email}.
        slots:
          campaignId: requestBody.campaignId
          email: requestBody.email
      - text: Cancel scheduled email {scheduledMessageId}.
        slots:
          scheduledMessageId: requestBody.scheduledMessageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/target'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a campaign email to an address
      effect: write
      questions:
      - How do I send an email to one address from an existing campaign?
      - Can I schedule a targeted email for later and override profile data fields?
      instructions:
      - text: Email {recipientEmail} using campaign {campaignId}.
        slots:
          recipientEmail: requestBody.recipientEmail
          campaignId: requestBody.campaignId
      - text: Send campaign {campaignId} email to user {recipientUserId} at {sendAt}.
        slots:
          campaignId: requestBody.campaignId
          recipientUserId: requestBody.recipientUserId
          sendAt: requestBody.sendAt
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email/viewInBrowser'].get
  update:
    x-apievangelist-phrasing:
      intent: View a previously sent email
      effect: read
      questions:
      - Can I see exactly how a sent email rendered for a user?
      - Where do I get the web view of an email that already went out?
      instructions:
      - text: Show the rendered email {messageId} sent to {email}.
        slots:
          messageId: query.messageId
          email: query.email
      - text: Open sent message {messageId} in browser view.
        slots:
          messageId: query.messageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/email/target'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a transactional email with attachments
      effect: write
      questions:
      - Can I attach files to a transactional email?
      - Which endpoint sends a transactional receipt email using a template?
      instructions:
      - text: Send transactional email campaign {campaignId} to {recipientEmail}.
        slots:
          campaignId: requestBody.campaignId
          recipientEmail: requestBody.recipientEmail
      - text: Send campaign {campaignId} to {recipientEmail} with attachments {attachments}.
        slots:
          campaignId: requestBody.campaignId
          recipientEmail: requestBody.recipientEmail
          attachments: requestBody.attachments
      method: generated
      generated: '2026-10-01'