# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Mailing API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-mailing-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: 41
- target: $.paths['/api/mailing/overview'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an overview of all mailing campaigns
      effect: read
      questions:
      - Where can I see every mailing campaign at once on an admin dashboard?
      - Does the campaign overview include both legacy mailing tasks and conveyor campaigns?
      instructions:
      - text: Show me the admin overview of all mailing campaigns.
      - text: Give me the global mailing dashboard with each row's legacy or campaign source.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/bounce-overview'].get
  update:
    x-apievangelist-phrasing:
      intent: Get global bounce statistics
      effect: read
      questions:
      - What are my bounce rates across all mailings, split into hard and soft bounces?
      - Which recipient domains are bouncing the most across my mailing tasks?
      instructions:
      - text: Show global bounce statistics across all mailings.
      - text: 'Break down campaign bounces by nature: dead addresses versus retryable soft bounces.'
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/warmup-overview'].get
  update:
    x-apievangelist-phrasing:
      intent: List email accounts in warmup
      effect: read
      questions:
      - Which of my email accounts are currently warming up?
      - Is there a single view of every sending mailbox still in warmup mode?
      instructions:
      - text: Show me all email accounts currently in warmup.
      - text: Give me the warmup overview for my sending mailboxes.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/pending-approvals'].get
  update:
    x-apievangelist-phrasing:
      intent: List campaigns awaiting approval
      effect: read
      questions:
      - Which mailing campaigns are waiting for admin approval?
      - Can a super admin see pending approvals across all tenants?
      instructions:
      - text: List the campaigns waiting for my approval.
      - text: Show the mailing approval queue.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/approve'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve a pending mailing campaign
      effect: write
      questions:
      - How do I approve a mailing campaign that is waiting for review?
      - Does approving a campaign start sending it right away, or is that a separate step?
      instructions:
      - text: Approve mailing campaign {task}.
        slots:
          task: path.taskId
      - text: Sign off on pending campaign {task} so it can be sent.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/reject'].post
  update:
    x-apievangelist-phrasing:
      intent: Reject a pending mailing campaign
      effect: destructive
      questions:
      - Can an admin turn down a mailing campaign submitted for approval?
      - What happens when I decline a campaign in the approval queue?
      instructions:
      - text: Reject pending mailing campaign {task}.
        slots:
          task: path.taskId
      - text: Decline approval for campaign {task}.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/creative-preview/{creativeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview a creative for approval
      effect: read
      questions:
      - Can I see what a campaign's email creative looks like before approving it?
      - Which database do I need to name to preview a creative under review?
      instructions:
      - text: Preview creative {creative} from database {db} before I approve it.
        slots:
          creative: path.creativeId
          db: query.dbName
      - text: Show me creative {creative} in {db} for approval review.
        slots:
          creative: path.creativeId
          db: query.dbName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a campaign's mailing configuration
      effect: read
      questions:
      - Where can I check how a mailing campaign is configured?
      - What sending settings are saved on a campaign right now?
      instructions:
      - text: Show the mailing configuration for campaign {task}.
        slots:
          task: path.taskId
      - text: Get the current send settings of mailing {task}.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/config'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a campaign's mailing configuration
      effect: write
      questions:
      - Can I change the sending settings of a mailing campaign after it's created?
      - How do I edit a campaign's mailing configuration?
      instructions:
      - text: Update the mailing configuration of campaign {task}.
        slots:
          task: path.taskId
      - text: Change the send settings saved on mailing {task}.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a mailing campaign
      effect: write
      questions:
      - How do I kick off a mailing campaign?
      - Can I launch a campaign directly from its task id?
      instructions:
      - text: Start mailing campaign {task}.
        slots:
          task: path.taskId
      - text: Launch campaign {task} now.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/start-sending'].post
  update:
    x-apievangelist-phrasing:
      intent: Start sending an approved campaign
      effect: write
      questions:
      - Once my campaign is approved, how do I actually begin sending it?
      - Why would starting an approved campaign fail if I edited the creative after approval?
      instructions:
      - text: Start sending approved campaign {task} and launch its streams.
        slots:
          task: path.taskId
      - text: Begin delivery of {task} now that it has been approved.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/batch-stats'].post
  update:
    x-apievangelist-phrasing:
      intent: Get stats for many mailing tasks at once
      effect: read
      questions:
      - Can I pull statistics for several mailing tasks in a single call?
      - Is there a bulk way to compare stats across a batch of mailings?
      instructions:
      - text: Get batch stats for my mailing tasks in one request.
      - text: Fetch combined statistics for a set of mailing tasks.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/start-list-stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a campaign's start-list statistics
      effect: read
      questions:
      - How big was the starting recipient list for a mailing campaign?
      - Where can I see statistics about the list a campaign started with?
      instructions:
      - text: Show start-list statistics for campaign {task}.
        slots:
          task: path.taskId
      - text: Get the starting audience numbers of mailing {task}.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get aggregate stats for a campaign
      effect: read
      questions:
      - What are the overall results of a mailing campaign so far?
      - Can I see total sent, delivered and failed counts for one campaign?
      instructions:
      - text: Show the aggregate stats for mailing campaign {task}.
        slots:
          task: path.taskId
      - text: Get all-time totals for campaign {task}.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/timeline'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a campaign's activity timeline
      effect: read
      questions:
      - What has happened over time in a mailing campaign?
      - Is there an event history showing when a campaign started, paused or changed?
      instructions:
      - text: Show the activity timeline for campaign {task}.
        slots:
          task: path.taskId
      - text: Walk me through what happened in mailing {task}, in order.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/speed'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a campaign's sending speed
      effect: read
      questions:
      - How fast is my mailing campaign sending right now?
      - Can I check the send rate metrics of a campaign?
      instructions:
      - text: Show the sending speed of campaign {task}.
        slots:
          task: path.taskId
      - text: Get send-rate metrics for mailing {task}.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/streams'].get
  update:
    x-apievangelist-phrasing:
      intent: List a campaign's sending streams
      effect: read
      questions:
      - Which sending streams is a mailing campaign using?
      - Can I list the parallel streams a campaign is sent through?
      instructions:
      - text: List the sending streams of campaign {task}.
        slots:
          task: path.taskId
      - text: Show me every stream running for mailing {task}.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/streams/{streamId}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get logs for a mailing stream
      effect: read
      questions:
      - Where can I read the full log of one sending stream?
      - Can I see the raw log output for a single stream in a campaign?
      instructions:
      - text: Show all logs for stream {stream} of campaign {task}.
        slots:
          task: path.taskId
          stream: path.streamId
      - text: Get the unfiltered log of stream {stream} in mailing {task}.
        slots:
          task: path.taskId
          stream: path.streamId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/streams/{streamId}/detail'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a mailing stream
      effect: read
      questions:
      - What account and settings is a specific sending stream using?
      - Can I inspect one stream's detailed state inside a campaign?
      instructions:
      - text: Show details of stream {stream} in campaign {task}.
        slots:
          task: path.taskId
          stream: path.streamId
      - text: Describe sending stream {stream} of mailing {task}.
        slots:
          task: path.taskId
          stream: path.streamId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/streams/{streamId}/logs-filtered'].get
  update:
    x-apievangelist-phrasing:
      intent: Get filtered, paged stream logs
      effect: read
      questions:
      - Can I filter a stream's logs by stage and status and page through them?
      - Which filters are available when reading a sending stream's log?
      instructions:
      - text: Show {status} logs at stage {stage} for stream {stream} of campaign {task}, page {page} with {size} per page.
        slots:
          task: path.taskId
          stream: path.streamId
          status: query.status
          stage: query.stage
          page: query.page
          size: query.pageSize
      - text: Filter stream {stream} logs in mailing {task} to status {status} at stage {stage}, page {page}, {size} rows.
        slots:
          task: path.taskId
          stream: path.streamId
          status: query.status
          stage: query.stage
          page: query.page
          size: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/logs'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all logs for a campaign
      effect: destructive
      questions:
      - Can a super admin wipe all the logs of a mailing campaign?
      - Is deleting a campaign's logs permanent?
      instructions:
      - text: Delete every log for mailing campaign {task}.
        slots:
          task: path.taskId
      - text: Purge the logs of campaign {task}.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List a campaign's recipients
      effect: read
      questions:
      - Who are the recipients in a mailing campaign and what is each one's status?
      - Can I search a campaign's recipient list by status or text?
      instructions:
      - text: List recipients of campaign {task} with status {status} matching {search}, page {page} of {size}.
        slots:
          task: path.taskId
          status: query.status
          search: query.search
          page: query.page
          size: query.pageSize
      - text: Search mailing {task} items for {search} with status {status}, page {page}, {size} per page.
        slots:
          task: path.taskId
          status: query.status
          search: query.search
          page: query.page
          size: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/items/{itemId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one campaign recipient
      effect: read
      questions:
      - Can I look up a single recipient item inside a mailing campaign?
      - What does one mailing item record contain?
      instructions:
      - text: Show mailing item {item} in campaign {task}.
        slots:
          task: path.taskId
          item: path.itemId
      - text: Get recipient record {item} from mailing {task}.
        slots:
          task: path.taskId
          item: path.itemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/items/{itemId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a campaign recipient's fields
      effect: write
      questions:
      - Can I fix the data on one recipient in a campaign, like a typo in their details?
      - How do I edit the fields of a single mailing item?
      instructions:
      - text: Update the fields of item {item} in campaign {task}.
        slots:
          task: path.taskId
          item: path.itemId
      - text: Correct recipient {item}'s details in mailing {task}.
        slots:
          task: path.taskId
          item: path.itemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/items/{itemId}/status'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a campaign recipient's status
      effect: write
      questions:
      - Can I manually set the send status of one recipient in a campaign?
      - How do I mark a single mailing item as a different status?
      instructions:
      - text: Set the status of item {item} in campaign {task}.
        slots:
          task: path.taskId
          item: path.itemId
      - text: Change recipient {item}'s mailing status in {task}.
        slots:
          task: path.taskId
          item: path.itemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/reset-errors'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry failed recipients in a campaign
      effect: write
      questions:
      - How do I requeue every recipient that failed in a mailing campaign?
      - Can failed mailing items be put back to pending in one go?
      instructions:
      - text: Reset all failed items in campaign {task} back to pending.
        slots:
          task: path.taskId
      - text: Retry every errored recipient of mailing {task}.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/reset-status/{status}'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset recipients of one status to pending
      effect: write
      questions:
      - Can an admin push all recipients with a particular status back to pending?
      - Is there a recovery tool to requeue mailing items by any status, not just errors?
      instructions:
      - text: Reset every item with status {status} in campaign {task} to pending.
        slots:
          task: path.taskId
          status: path.status
      - text: Requeue all {status} recipients of mailing {task} for recovery.
        slots:
          task: path.taskId
          status: path.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/stats/today'].get
  update:
    x-apievangelist-phrasing:
      intent: Get today's stats for a campaign
      effect: read
      questions:
      - How many emails has my campaign sent today?
      - Can I see a campaign's numbers for the current day only?
      instructions:
      - text: Show today's stats for campaign {task}.
        slots:
          task: path.taskId
      - text: Get today's send numbers for mailing {task}.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/ab-test'].get
  update:
    x-apievangelist-phrasing:
      intent: Get A/B test results for a campaign
      effect: read
      questions:
      - Which variant is winning the A/B test in my mailing campaign?
      - Where can I compare split-test statistics for a campaign?
      instructions:
      - text: Show A/B test statistics for campaign {task}.
        slots:
          task: path.taskId
      - text: Compare the split-test variants of mailing {task}.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/analytics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get per-domain campaign analytics
      effect: read
      questions:
      - How is my campaign performing at each recipient domain?
      - Can I see a mailing's results broken down by email domain?
      instructions:
      - text: Show per-domain analytics for campaign {task}.
        slots:
          task: path.taskId
      - text: Break down mailing {task} results by recipient domain.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/control-email-stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get control-email tracking stats
      effect: read
      questions:
      - Are my control emails landing during a campaign?
      - Where do I see tracking results for the control emails seeded into a mailing?
      instructions:
      - text: Show control-email stats for campaign {task}.
        slots:
          task: path.taskId
      - text: Get control-email tracking results of mailing {task}.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/control-email-autopause/evaluate'].post
  update:
    x-apievangelist-phrasing:
      intent: Evaluate control-email auto-pause rules
      effect: write
      questions:
      - Can I manually trigger the control-email auto-pause check for a campaign?
      - Will a campaign pause itself if control emails stop arriving?
      instructions:
      - text: Evaluate the control-email auto-pause rules for campaign {task} now.
        slots:
          task: path.taskId
      - text: Run the auto-pause check on mailing {task}'s control emails.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/export.csv'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a campaign as CSV
      effect: read
      questions:
      - Can I download a mailing campaign's data as a spreadsheet?
      - What format is the campaign data export in?
      instructions:
      - text: Export campaign {task} as CSV.
        slots:
          task: path.taskId
      - text: Download mailing {task} as a CSV file.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/report.pdf'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a client-ready campaign PDF report
      effect: read
      questions:
      - Can I give my client a PDF report of a mailing campaign?
      - Is there a printable report of campaign results?
      instructions:
      - text: Export a client-ready PDF report for campaign {task}.
        slots:
          task: path.taskId
      - text: Generate the PDF report of mailing {task}.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/block-guard/dashboard'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the BlockGuard dashboard
      effect: read
      questions:
      - Which templates got flagged and which accounts were paused by BlockGuard in a mailing?
      - Where can I see blocks detected during a campaign?
      instructions:
      - text: Show the BlockGuard dashboard for mailing {task}.
        slots:
          task: query.taskId
      - text: List blocks, flagged templates and paused accounts for campaign {task}.
        slots:
          task: query.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/block-guard/template/{templateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a template's block history
      effect: read
      questions:
      - How often has a particular email template been blocked?
      - Can I see the block-event history of one template?
      instructions:
      - text: Show block-event history for template {template}.
        slots:
          template: path.templateId
      - text: List the block events that stopped template {template}.
        slots:
          template: path.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/block-guard/template/{templateId}/unblock'].post
  update:
    x-apievangelist-phrasing:
      intent: Unblock a flagged template
      effect: write
      questions:
      - Can I clear a BlockGuard flag on a template so it can be used again?
      - How do I manually unblock a template that was stopped?
      instructions:
      - text: Unblock template {template}.
        slots:
          template: path.templateId
      - text: Clear the BlockGuard flag on template {template}.
        slots:
          template: path.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/block-guard/account/{accountId}/reset-limits'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset limits for one email account
      effect: write
      questions:
      - Can I unpause a single sending account without losing its stats?
      - How do I zero the working counters on one mailbox that got auto-paused?
      instructions:
      - text: Reset the limit counters for email account {account} and clear its auto-pause.
        slots:
          account: path.accountId
      - text: Unpause account {account} and zero its working counters, keeping stats.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/{taskId}/reset-limits'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset limits for a whole mailing
      effect: write
      questions:
      - Can I unpause every blocked account in a mailing at once?
      - Does resetting a mailing's limits erase its block events or stats?
      instructions:
      - text: Reset limit counters for the whole mailing {task}.
        slots:
          task: path.taskId
      - text: Un-pause all blocked accounts in campaign {task}, keeping block history.
        slots:
          task: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/block-guard/account/{accountId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email account's block history
      effect: read
      questions:
      - Has a specific sending mailbox been blocked before, and when?
      - Can I see the block-event history of one email account?
      instructions:
      - text: Show block-event history for email account {account}.
        slots:
          account: path.accountId
      - text: List every block recorded against account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mailing/block-guard/providers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get block stats per email provider
      effect: read
      questions:
      - Which mailbox providers are blocking my sends the most?
      - Can I see block counts grouped by email provider?
      instructions:
      - text: Show block statistics per email provider.
      - text: Rank email providers by how many blocks they've caused.
      method: generated
      generated: '2026-10-01'