Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Dialog Linker API

7 actions 7 updates phrasing extends openapi/live-direct-marketing-online-dialog-linker-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/dialog-linker/relink/{dialogId}'].post
$.paths['/api/dialog-linker/backfill'].post
$.paths['/api/dialog-linker/stats'].get
$.paths['/api/dialog-linker/failure-summary'].get
$.paths['/api/dialog-linker/logs/{dialogId}'].get
$.paths['/api/dialog-linker/logs'].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 Dialog Linker API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-dialog-linker-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/dialog-linker/relink/{dialogId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-run CRM linking for one dialog
      effect: write
      questions:
      - Can I re-run the linker on one conversation that was matched wrong?
      - What if a dialog failed to link to its contact the first time?
      instructions:
      - text: Re-run the linker for dialog {dialogId}.
        slots:
          dialogId: path.dialogId
      - text: Relink conversation {dialogId} to CRM records.
        slots:
          dialogId: path.dialogId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/dialog-linker/backfill'].post
  update:
    x-apievangelist-phrasing:
      intent: Backfill dialog linking across the tenant
      effect: write
      questions:
      - Can an admin link every old conversation in the workspace in one run?
      - Is there a backfill for dialogs that were never linked?
      instructions:
      - text: Run the dialog linker backfill across the tenant.
      - text: Link all historical conversations in my workspace.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/dialog-linker/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get dialog linker statistics
      effect: read
      questions:
      - How many conversations are linked, pending or failed?
      - What's the status breakdown of the dialog linker?
      instructions:
      - text: Show dialog linker statistics by status.
      - text: Count linked versus failed conversations.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/dialog-linker/failure-summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize dialog linking failures
      effect: read
      questions:
      - Why are conversations failing to link to contacts?
      - Which failure reasons are most common for the linker?
      instructions:
      - text: Show the top {limit} linker failure reasons.
        slots:
          limit: query.limit
      - text: Summarize the {limit} most frequent dialog linking failures and log coverage.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/dialog-linker/logs/{dialogId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get linker logs for one dialog
      effect: read
      questions:
      - What did the linker try when matching a specific conversation?
      - Can I page through the linking log of one dialog?
      instructions:
      - text: Get linker logs for dialog {dialogId}, page {page}, {limit} per page.
        slots:
          dialogId: path.dialogId
          page: query.page
          limit: query.limit
      - text: Show how conversation {dialogId} was linked.
        slots:
          dialogId: path.dialogId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/dialog-linker/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the full dialog linker log
      effect: read
      questions:
      - Is there an admin technical log of every linker run across the tenant?
      - Can I browse all dialog linking logs at once?
      instructions:
      - text: Show all dialog linker logs, page {page} with {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      - text: Open the tenant-wide linker tech log at page {page}.
        slots:
          page: query.page
      method: generated
      generated: '2026-10-01'