Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Mail Agent API

9 actions 9 updates phrasing extends openapi/live-direct-marketing-online-mail-agent-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 9

$.info
$.paths['/api/mail-agent/status'].get
$.paths['/api/mail-agent/settings'].get
$.paths['/api/mail-agent/settings'].post
$.paths['/api/mail-agent/token/regenerate'].post
$.paths['/api/mail-agent/stats/reset'].post
$.paths['/api/mail-agent/disconnect'].post
$.paths['/api/mail-agent/download/windows'].get
$.paths['/api/mail-agent/qr'].get

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 Mail Agent API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-mail-agent-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: 8
- target: $.paths['/api/mail-agent/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the mail agent connection
      effect: read
      questions:
      - Is my mail agent connected and sending right now?
      - What sending stats has the mail agent reported?
      instructions:
      - text: Show the mail agent connection status and stats.
      - text: Check whether my mail agent is online.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mail-agent/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: View mail agent settings
      effect: read
      questions:
      - What are my current mail agent settings?
      - Is the mail agent enabled in my workspace?
      instructions:
      - text: Show my current mail agent settings.
      - text: Get the mail agent configuration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mail-agent/settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn the mail agent on or off
      effect: write
      questions:
      - How do I enable or disable the mail agent?
      - Can I pause the mail agent by switching it off?
      instructions:
      - text: Toggle the mail agent enabled flag.
      - text: Switch the mail agent off for now.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mail-agent/token/regenerate'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate the mail agent token
      effect: destructive
      questions:
      - Can I issue a new auth token for the mail agent?
      - What do I do if my mail agent token was exposed?
      instructions:
      - text: Regenerate the mail agent auth token.
      - text: Rotate my mail agent token.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mail-agent/stats/reset'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset mail agent statistics
      effect: destructive
      questions:
      - Can I zero out the mail agent's sending counters?
      - How do I start the mail agent stats fresh?
      instructions:
      - text: Reset the mail agent statistics counters.
      - text: Clear my mail agent stats.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mail-agent/disconnect'].post
  update:
    x-apievangelist-phrasing:
      intent: Disconnect the mail agent
      effect: destructive
      questions:
      - How do I disconnect the mail agent session from my account?
      - Can I force the connected mail agent offline?
      instructions:
      - text: Disconnect the mail agent session.
      - text: Kick my mail agent off its current connection.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mail-agent/download/windows'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the Windows mail agent
      effect: read
      questions:
      - Where do I download the mail agent for Windows?
      - Does the Windows mail agent come with my token already configured?
      instructions:
      - text: Download the Windows mail agent bundle.
      - text: Get the Windows mail agent with my token pre-configured.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/mail-agent/qr'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Android mail agent pairing QR
      effect: read
      questions:
      - How do I pair the Android mail agent with my account?
      - Can I get a QR code to connect my phone as a mail agent?
      instructions:
      - text: Get the QR code for pairing the Android mail agent.
      - text: Show the SVG pairing QR for my Android phone.
      method: generated
      generated: '2026-10-01'