Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Domain Watch Placement API

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

$.info

$.paths['/api/domain-watch/placement'].get

$.paths['/api/domain-watch/placement'].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 Domain Watch Placement API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-domainwatchplacement-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: 2
- target: $.paths['/api/domain-watch/placement'].get
  update:
    x-apievangelist-phrasing:
      intent: Get domain-watch placement results
      effect: read
      questions:
      - Where did my watched domain's email land in the placement check?
      - Can I read the placement result for one domain-watch test?
      instructions:
      - text: Show domain-watch placement for watch {id}, test {test}, token {token}.
        slots:
          id: query.id
          test: query.test
          token: query.token
      - text: Get placement result of test {test} for domain watch {id} using token {token}.
        slots:
          id: query.id
          test: query.test
          token: query.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/domain-watch/placement'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a domain-watch placement check
      effect: write
      questions:
      - Can I start an inbox placement check for a watched domain?
      - How do I trigger a new placement run in domain watch?
      instructions:
      - text: Start a domain-watch placement check.
      - text: Kick off a new placement test for my watched domain.
      method: generated
      generated: '2026-10-01'