Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Presend API

4 actions 4 updates phrasing extends openapi/live-direct-marketing-online-presend-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Live Direct Marketing's API. It is a proposal applied on top of the contract, not a document Live Direct Marketing publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/api/presend'].post
$.paths['/api/presend/{token}'].get
$.paths['/api/presend/{token}'].delete

OpenAPI Overlay

Raw ↑
# 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 Presend API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-presend-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/presend'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit an email for pre-send checks
      effect: write
      questions:
      - Can I check my email for spam problems before I send it?
      - What do I need to submit for a pre-send check, just from and subject?
      instructions:
      - text: Run a pre-send check on an email from {from} with subject {subject}.
        slots:
          from: requestBody.from
          subject: requestBody.subject
      - text: 'Analyze this email before sending: from {from}, subject {subject}, body {html}.'
        slots:
          from: requestBody.from
          subject: requestBody.subject
          html: requestBody.html
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/presend/{token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get pre-send check results
      effect: read
      questions:
      - Is my pre-send analysis done, and what did it find?
      - Where can I read the results of a pre-send check?
      instructions:
      - text: Show pre-send check {token}.
        slots:
          token: path.token
      - text: Get the results of presend {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/presend/{token}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pre-send check
      effect: destructive
      questions:
      - Can I delete a pre-send check and its email content?
      - How do I remove a presend analysis I no longer need?
      instructions:
      - text: Delete pre-send check {token}.
        slots:
          token: path.token
      - text: Remove presend {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'