Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Email Accounts / Inbox Ingest…

2 actions 2 updates phrasing extends openapi/live-direct-marketing-online-email-accounts-inbox-ingest-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 2

$.info

$.paths['/api/internal/mail-arrived'].post

OpenAPI Overlay

# 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 Email Accounts / Inbox Ingest…
  version: 1.0.0
extends: openapi/live-direct-marketing-online-email-accounts-inbox-ingest-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: 1
- target: $.paths['/api/internal/mail-arrived'].post
  update:
    x-apievangelist-phrasing:
      intent: Signal new mail and trigger an IMAP fetch
      effect: write
      questions:
      - How can an internal service tell the platform new mail just arrived?
      - Is there a way to force an immediate IMAP fetch instead of waiting for polling?
      instructions:
      - text: Notify that new mail arrived using internal key {x-internal-key}.
        slots:
          x-internal-key: header.x-internal-key
      - text: Trigger an immediate inbox fetch authenticated with {x-internal-key}.
        slots:
          x-internal-key: header.x-internal-key
      method: generated
      generated: '2026-10-01'