Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Exports API

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

$.info

$.paths['/api/exports/columns'].get

$.paths['/api/exports'].get

$.paths['/api/exports'].post

$.paths['/api/exports/{id}'].get

$.paths['/api/exports/{id}/download'].get

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 Exports API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-exports-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: 5
- target: $.paths['/api/exports/columns'].get
  update:
    x-apievangelist-phrasing:
      intent: List exportable columns for an entity
      effect: read
      questions:
      - Which columns can I include when exporting contacts?
      - What fields and column groups are available for an export?
      instructions:
      - text: List exportable columns for {entity}.
        slots:
          entity: query.entity
      - text: Show the column groups I can export for entity {entity}.
        slots:
          entity: query.entity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/exports'].get
  update:
    x-apievangelist-phrasing:
      intent: List my export jobs
      effect: read
      questions:
      - What exports have I requested?
      - Which of my export jobs are still running?
      instructions:
      - text: List my export jobs.
      - text: Show all the exports I have started.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/exports'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a data export job
      effect: write
      questions:
      - How do I export my data to a file?
      - Can I start an export with specific parameters like chosen columns?
      instructions:
      - text: Start a {type} export.
        slots:
          type: requestBody.type
      - text: Create a {type} export job with parameters {params}.
        slots:
          type: requestBody.type
          params: requestBody.params
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/exports/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an export job's status
      effect: read
      questions:
      - Is my export finished yet?
      - What state is a particular export job in?
      instructions:
      - text: Check the status of export {id}.
        slots:
          id: path.id
      - text: Tell me whether export job {id} is complete.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/exports/{id}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a finished export file
      effect: read
      questions:
      - Where do I get the file once my export is done?
      - Can I download the output of a completed export?
      instructions:
      - text: Download export {id}.
        slots:
          id: path.id
      - text: Get the file produced by export job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'