Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Company List Groups API

6 actions 6 updates phrasing extends openapi/live-direct-marketing-online-company-list-groups-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/company-list-groups'].get

$.paths['/api/company-list-groups'].post

$.paths['/api/company-list-groups/reorder'].post

$.paths['/api/company-list-groups/{id}'].delete

$.paths['/api/company-list-groups/{id}'].patch

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 Company List Groups API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-company-list-groups-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/company-list-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List company list groups
      effect: read
      questions:
      - How are my company lists grouped into folders?
      - Can I get the folder tree of company list groups?
      instructions:
      - text: List all my company list groups.
      - text: Show the company list group tree with parent ids.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/company-list-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a company list group
      effect: write
      questions:
      - How do I create a folder to organize company lists?
      - Can I add a new group for my company lists?
      instructions:
      - text: Create a new company list group.
      - text: Add a folder for organizing my company lists.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/company-list-groups/reorder'].post
  update:
    x-apievangelist-phrasing:
      intent: Reorder company list groups
      effect: write
      questions:
      - Can I change the order company list groups appear in?
      - Is there a way to re-sort my company list folders?
      instructions:
      - text: Reorder my company list groups.
      - text: Save a new sort order for company list folders.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/company-list-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a company list group
      effect: destructive
      questions:
      - What happens to the lists inside a company list group when I delete it?
      - Can I remove a company list folder?
      instructions:
      - text: Delete company list group {id}.
        slots:
          id: path.id
      - text: Remove the company list folder {id}, detaching its lists.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/company-list-groups/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a company list group
      effect: write
      questions:
      - Can I rename or recolor a company list group?
      - How do I move a company list group under another parent?
      instructions:
      - text: Update company list group {id}.
        slots:
          id: path.id
      - text: Rename or move company list folder {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'