Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Marking API

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

$.info
$.paths['/api/marking/patterns'].get
$.paths['/api/marking/patterns'].post
$.paths['/api/marking/patterns/{id}/toggle'].patch
$.paths['/api/marking/patterns/{id}'].delete
$.paths['/api/marking/classify'].post
$.paths['/api/marking/dialogs/{id}/classify'].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 Marking API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-marking-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: 6
- target: $.paths['/api/marking/patterns'].get
  update:
    x-apievangelist-phrasing:
      intent: List message marking patterns
      effect: read
      questions:
      - Which patterns are used to auto-mark incoming replies?
      - Can I list only enabled marking patterns for a given result?
      instructions:
      - text: List marking patterns with result {result} and enabled {enabled}.
        slots:
          result: query.result
          enabled: query.enabled
      - text: Show enabled={enabled} patterns that mark messages as {result}.
        slots:
          enabled: query.enabled
          result: query.result
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/marking/patterns'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a marking pattern
      effect: write
      questions:
      - How do I add a new rule for automatically marking replies?
      - Can I define my own message marking pattern?
      instructions:
      - text: Create a new marking pattern.
      - text: Add a pattern for auto-marking incoming messages.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/marking/patterns/{id}/toggle'].patch
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable a marking pattern
      effect: write
      questions:
      - Can I switch off a marking pattern without deleting it?
      - How do I re-enable a disabled marking pattern?
      instructions:
      - text: Toggle marking pattern {id} on or off.
        slots:
          id: path.id
      - text: Disable marking pattern {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/marking/patterns/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a marking pattern
      effect: destructive
      questions:
      - How do I permanently remove a marking pattern?
      - Can I delete a reply-marking rule I no longer want?
      instructions:
      - text: Delete marking pattern {id}.
        slots:
          id: path.id
      - text: Remove pattern {id} from message marking.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/marking/classify'].post
  update:
    x-apievangelist-phrasing:
      intent: Classify a message text against marking patterns
      effect: read
      questions:
      - Which marking pattern would a given message text match?
      - Can I test a sample reply against my marking rules?
      instructions:
      - text: Classify this message against the marking patterns.
      - text: Test a sample reply text against my marking rules.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/marking/dialogs/{id}/classify'].post
  update:
    x-apievangelist-phrasing:
      intent: Classify a dialog against marking patterns
      effect: read
      questions:
      - How would an existing conversation be marked by my patterns?
      - Can I run marking classification on one specific dialog?
      instructions:
      - text: Classify dialog {id} with the marking patterns.
        slots:
          id: path.id
      - text: Check which marking pattern dialog {id} matches.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'