Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Agency API

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

$.info

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

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

$.paths['/api/agency/stats'].get

$.paths['/api/agency/{childId}'].delete

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 Agency API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-agency-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: 4
- target: $.paths['/api/agency'].get
  update:
    x-apievangelist-phrasing:
      intent: List agency sub-accounts
      effect: read
      questions:
      - Which client sub-accounts sit under my agency account?
      - Can I see the parent tenant details alongside my sub-accounts?
      instructions:
      - text: List my agency sub-accounts.
      - text: Show the sub-accounts and parent tenant info for tenant {tenant}.
        slots:
          tenant: header.X-Tenant-Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/agency'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a client sub-account
      effect: write
      questions:
      - How do I spin up a new sub-account for an agency client?
      - Can I create a child tenant under my own account?
      instructions:
      - text: Create a new sub-account under my agency.
      - text: Add a child tenant under agency {tenant}.
        slots:
          tenant: header.X-Tenant-Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/agency/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get stats per agency sub-account
      effect: read
      questions:
      - How is each of my agency's client accounts performing?
      - Is there an aggregate stats view per sub-account?
      instructions:
      - text: Show aggregate stats for each sub-account.
      - text: Compare activity across my agency's client accounts.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/agency/{childId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a sub-account from the agency
      effect: destructive
      questions:
      - How do I remove a client sub-account from my agency?
      - Can I un-parent a sub-account so it stands on its own?
      instructions:
      - text: Detach sub-account {childId} from my agency.
        slots:
          childId: path.childId
      - text: Un-parent child tenant {childId}.
        slots:
          childId: path.childId
      method: generated
      generated: '2026-10-01'