API Evangelist conversational phrasing for Paubox Marketing Campaign Mailings API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Paubox Marketing Campaign Mailings API
  version: 1.0.0
extends: openapi/paubox-campaign-mailings-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: 8
- target: $.paths['/campaign_mailings'].get
  update:
    x-apievangelist-phrasing:
      intent: List marketing campaign emails
      effect: read
      questions:
      - What marketing emails do I have saved in my account?
      - Can I filter my campaign emails to only those built in the HTML editor?
      - Is there a way to get every campaign mailing in one response without paging?
      instructions:
      - text: List my campaign mailings whose subject matches {search}.
        slots:
          search: query.search
      - text: Show campaign mailings authored with the {template_type} editor.
        slots:
          template_type: query.template_type
      - text: Get page {page} of my campaign mailings, {items} per page.
        slots:
          page: query.page
          items: query.items
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign_mailings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a marketing campaign email
      effect: write
      questions:
      - How do I draft a new marketing email through the API before sending it?
      - Does a new campaign mailing need a unique subject line?
      - Will an unsubscribe footer be added automatically to my new campaign email's HTML?
      instructions:
      - text: Create a new campaign mailing with {campaign_mailing}.
        slots:
          campaign_mailing: requestBody.campaign_mailing
      - text: Save a draft marketing email for our March newsletter.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign_mailings/{campaign_mailing_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one campaign mailing with its content
      effect: read
      questions:
      - How can I see the HTML and text content of a specific campaign email?
      - Can I include the images when fetching a single marketing email?
      instructions:
      - text: Fetch campaign mailing {campaign_mailing_id} with its full content.
        slots:
          campaign_mailing_id: path.campaign_mailing_id
      - text: Get campaign mailing {campaign_mailing_id} including its image data ({with_images}).
        slots:
          campaign_mailing_id: path.campaign_mailing_id
          with_images: query.with_images
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign_mailings/{campaign_mailing_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit an existing campaign mailing
      effect: write
      questions:
      - How do I change the subject of a marketing email I already created?
      - Can I update only some fields of a campaign mailing and leave the rest alone?
      instructions:
      - text: Update campaign mailing {campaign_mailing_id} with {campaign_mailing}.
        slots:
          campaign_mailing_id: path.campaign_mailing_id
          campaign_mailing: requestBody.campaign_mailing
      - text: Revise the existing campaign mailing {campaign_mailing_id} to use a new subject line.
        slots:
          campaign_mailing_id: path.campaign_mailing_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign_mailings/{campaign_mailing_id}/send_test_email'].get
  update:
    x-apievangelist-phrasing:
      intent: Send a test preview of a campaign email
      effect: write
      questions:
      - Can I send myself a preview of a campaign email to check how it renders?
      - Do test sends of a marketing email show up in my analytics?
      instructions:
      - text: Send a test of campaign mailing {campaign_mailing_id} to {to_email}.
        slots:
          campaign_mailing_id: path.campaign_mailing_id
          to_email: query.to_email
      - text: Email a [Test] preview of mailing {campaign_mailing_id} to {to_email} so I can proof it.
        slots:
          campaign_mailing_id: path.campaign_mailing_id
          to_email: query.to_email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign_mailings_bulk_delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete campaign mailings
      effect: destructive
      questions:
      - How do I delete marketing emails I no longer need?
      - Is deleting a campaign mailing reversible, and does it remove its send records too?
      instructions:
      - text: Delete the campaign mailings {campaign_mailing_ids}.
        slots:
          campaign_mailing_ids: requestBody.campaign_mailing_ids
      - text: Permanently remove marketing email {campaign_mailing_ids} and its delivery history.
        slots:
          campaign_mailing_ids: requestBody.campaign_mailing_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign_mailing_sends'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a campaign email to recipients now
      effect: write
      questions:
      - How do I trigger an immediate send of a marketing email I built in the web interface?
      - Where do I find the campaign mailing ID needed to send a campaign right away?
      instructions:
      - text: Send campaign mailing {campaign_mailing_id} now using {campaign_mailing_send}.
        slots:
          campaign_mailing_id: requestBody.campaign_mailing_id
          campaign_mailing_send: requestBody.campaign_mailing_send
      - text: Blast marketing email {campaign_mailing_id} out immediately with send settings {campaign_mailing_send}.
        slots:
          campaign_mailing_id: requestBody.campaign_mailing_id
          campaign_mailing_send: requestBody.campaign_mailing_send
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign_mailing_schedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a campaign email for a future time
      effect: write
      questions:
      - Can I schedule a marketing email to go out at a specific date and time?
      - Does a scheduled campaign need to be sent from a verified domain?
      - Can extra recipients be added to a scheduled campaign outside the list?
      instructions:
      - text: Schedule a campaign with subject {subject} to list {subscription_list_id} at {send_at}.
        slots:
          subject: requestBody.subject
          subscription_list_id: requestBody.subscription_list_id
          send_at: requestBody.send_at
      - text: Schedule {subject} for {send_at} from {from_name} <{from_email}> to list {subscription_list_id}, sent by {sender_email}.
        slots:
          subject: requestBody.subject
          send_at: requestBody.send_at
          from_name: requestBody.from_name
          from_email: requestBody.from_email
          subscription_list_id: requestBody.subscription_list_id
          sender_email: requestBody.sender_email
      - text: Schedule a campaign to dynamic list {dynamic_list_id} at {send_at}.
        slots:
          dynamic_list_id: requestBody.dynamic_list_id
          send_at: requestBody.send_at
      method: generated
      generated: '2026-10-01'