Live Direct Marketing · OpenAPI Overlay 1.0.0

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

10 actions 10 updates phrasing extends openapi/live-direct-marketing-online-domain-watch-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 10

$.info
$.paths['/api/domain-watch/start'].get
$.paths['/api/domain-watch'].post
$.paths['/api/domain-watch/confirm'].get
$.paths['/api/domain-watch/confirm'].post
$.paths['/api/domain-watch/manage'].get
$.paths['/api/domain-watch/access'].post
$.paths['/api/domain-watch/stop'].post
$.paths['/api/domain-watch/unsubscribe'].get
$.paths['/api/domain-watch/unsubscribe'].post

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 Domain Watch API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-domain-watch-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: 9
- target: $.paths['/api/domain-watch/start'].get
  update:
    x-apievangelist-phrasing:
      intent: Start domain watch for a domain
      effect: read
      questions:
      - Where do I begin setting up monitoring for one of my sending domains?
      - Can I open the domain watch start page for a specific domain?
      instructions:
      - text: Start domain watch for {domain}.
        slots:
          domain: query.domain
      - text: Open the domain watch setup for {domain}.
        slots:
          domain: query.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/domain-watch'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a domain watch confirmation email
      effect: write
      questions:
      - How do I get the confirmation email needed before domain monitoring starts?
      - Does requesting domain watch turn monitoring on immediately?
      instructions:
      - text: Request a domain watch confirmation email for my domain.
      - text: Send me the per-domain monitoring confirmation email.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/domain-watch/confirm'].get
  update:
    x-apievangelist-phrasing:
      intent: View the domain watch consent page
      effect: read
      questions:
      - Will clicking the domain watch confirmation link subscribe my mailbox automatically?
      - What does the consent page from the confirmation email show?
      instructions:
      - text: Open the domain watch consent page for token {token}.
        slots:
          token: query.token
      - text: Show the read-only confirmation page for token {token}.
        slots:
          token: query.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/domain-watch/confirm'].post
  update:
    x-apievangelist-phrasing:
      intent: Confirm consent and activate domain watch
      effect: write
      questions:
      - How do I give explicit consent so monitoring of my domain actually starts?
      - Does confirming activate monitoring for all my domains or just one?
      instructions:
      - text: Confirm consent and activate domain watch for this domain.
      - text: Record my consent to start monitoring the domain.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/domain-watch/manage'].get
  update:
    x-apievangelist-phrasing:
      intent: Open the domain watch management page
      effect: read
      questions:
      - Where can I manage an existing domain watch subscription from my email link?
      - Can I see my domain monitoring settings using a manage token?
      instructions:
      - text: Open domain watch management for token {token}.
        slots:
          token: query.token
      - text: Show my domain watch subscription using manage token {token}.
        slots:
          token: query.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/domain-watch/access'].post
  update:
    x-apievangelist-phrasing:
      intent: Request access to manage domain watch
      effect: write
      questions:
      - I lost my link; can I request access to manage my domain watch again?
      - Is there a way to get a fresh management link for domain monitoring?
      instructions:
      - text: Request access to manage my domain watch.
      - text: Send me a domain watch management link.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/domain-watch/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop domain watch monitoring
      effect: destructive
      questions:
      - Can I turn off monitoring for a domain I am watching?
      - What is the way to stop domain watch from my management page?
      instructions:
      - text: Stop domain watch monitoring.
      - text: Turn off monitoring for my watched domain.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/domain-watch/unsubscribe'].get
  update:
    x-apievangelist-phrasing:
      intent: View the domain watch unsubscribe page
      effect: read
      questions:
      - What does the unsubscribe link in a domain watch email open?
      - Can I review what I'm unsubscribing from before confirming?
      instructions:
      - text: Open the domain watch unsubscribe page for token {token}.
        slots:
          token: query.token
      - text: Show the unsubscribe confirmation screen for token {token}.
        slots:
          token: query.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/domain-watch/unsubscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe one domain from domain watch
      effect: destructive
      questions:
      - Can I unsubscribe a single domain from monitoring emails with one click?
      - Does the domain watch unsubscribe support RFC 8058 one-click POST?
      instructions:
      - text: Unsubscribe the domain for token {token} from domain watch.
        slots:
          token: query.token
      - text: One-click unsubscribe using token {token}.
        slots:
          token: query.token
      method: generated
      generated: '2026-10-01'