Live Direct Marketing · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/live-direct-marketing-online-contact-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/contact-list-groups'].get
$.paths['/api/contact-list-groups'].post
$.paths['/api/contact-list-groups/reorder'].post
$.paths['/api/contact-list-groups/{id}'].delete
$.paths['/api/contact-list-groups/{id}'].patch

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 Contact List Groups API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-contact-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/contact-list-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List contact list groups
      effect: read
      questions:
      - How are my contact lists organized into groups?
      - Can I get the contact list group tree with parent ids?
      instructions:
      - text: List my contact list groups.
      - text: Show the contact list group tree.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contact-list-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contact list group
      effect: write
      questions:
      - How do I make a folder to organize my contact lists?
      - Can I nest a new contact list group under another one?
      instructions:
      - text: Create a contact list group.
      - text: Add a new group for organizing contact lists.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contact-list-groups/reorder'].post
  update:
    x-apievangelist-phrasing:
      intent: Reorder contact list groups
      effect: write
      questions:
      - Can I change the order my contact list groups appear in?
      - How do I set a custom sort order for list groups?
      instructions:
      - text: Reorder my contact list groups.
      - text: Apply a new sort order to my contact list groups.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contact-list-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contact list group
      effect: destructive
      questions:
      - What happens to the lists inside a group when I delete the group?
      - Can I delete a contact list group without deleting its lists?
      instructions:
      - text: Delete contact list group {id}.
        slots:
          id: path.id
      - text: Remove list group {id} and detach its lists.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contact-list-groups/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a contact list group
      effect: write
      questions:
      - Can I rename a contact list group or change its color?
      - How do I move a contact list group under a different parent?
      instructions:
      - text: Update contact list group {id}.
        slots:
          id: path.id
      - text: Rename contact list group {id} and change its color.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'