Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Recheck API

5 actions 5 updates phrasing extends openapi/live-direct-marketing-online-recheck-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 5

$.info
$.paths['/api/tests/{token}/recheck'].post
$.paths['/api/tests/{token}/recheck-24h'].get
$.paths['/api/tests/{token}/recheck-24h'].post
$.paths['/api/tests/{token}/recheck-24h'].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 Recheck API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-recheck-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/tests/{token}/recheck'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule an inbox placement recheck
      effect: write
      questions:
      - Can I ask for my deliverability test to be checked again?
      - How do I request a recheck of where my test email landed?
      instructions:
      - text: Schedule a recheck for test {token}.
        slots:
          token: path.token
      - text: Queue another placement check on test {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tests/{token}/recheck-24h'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the 24-hour placement recheck results
      effect: read
      questions:
      - Did my email's inbox placement change after 24 hours?
      - What snapshots does the next-day recheck have so far?
      instructions:
      - text: Show the 24-hour recheck state for test {token}.
        slots:
          token: path.token
      - text: Get the next-day placement snapshots of test {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tests/{token}/recheck-24h'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a 24-hour placement recheck
      effect: write
      questions:
      - Can I rescan the same test message a day later without sending a new one?
      - Is an email subscription required to get a next-day placement recheck?
      instructions:
      - text: Schedule a 24-hour recheck for test {token}.
        slots:
          token: path.token
      - text: Rescan the original message of test {token} tomorrow.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tests/{token}/recheck-24h'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a scheduled 24-hour recheck
      effect: destructive
      questions:
      - How do I call off the next-day recheck I scheduled?
      - Can I cancel a pending 24-hour placement scan?
      instructions:
      - text: Cancel the 24-hour recheck for test {token}.
        slots:
          token: path.token
      - text: Drop the scheduled next-day scan on test {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'