Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Contact Lists API

12 actions 12 updates phrasing extends openapi/live-direct-marketing-online-contact-lists-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 12

$.info
$.paths['/api/contact-lists'].get
$.paths['/api/contact-lists'].post
$.paths['/api/contact-lists/{id}'].delete
$.paths['/api/contact-lists/{id}'].patch
$.paths['/api/contact-lists/reorder'].post
$.paths['/api/contact-lists/{id}/contacts'].post
$.paths['/api/contact-lists/{id}/contacts'].delete
$.paths['/api/contact-lists/{id}/duplicate'].post
$.paths['/api/contact-lists/all-statistics'].get
$.paths['/api/contact-lists/compare'].get
$.paths['/api/contact-lists/{id}/statistics'].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 Contact Lists API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-contact-lists-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: 11
- target: $.paths['/api/contact-lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List contact lists
      effect: read
      questions:
      - What contact lists do I have?
      - Can I see all the contact lists in my workspace?
      instructions:
      - text: List all my contact lists.
      - text: Show every contact list in this tenant.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contact-lists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contact list
      effect: write
      questions:
      - How do I create a new contact list?
      - Can I make a smart list that fills itself from filters?
      instructions:
      - text: Create a contact list named {name}.
        slots:
          name: requestBody.name
      - text: Make a smart contact list {name} using filters {filters}.
        slots:
          name: requestBody.name
          filters: requestBody.smartFilters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contact-lists/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contact list
      effect: destructive
      questions:
      - Can I delete a contact list I no longer need?
      - What happens when I remove a whole contact list?
      instructions:
      - text: Delete contact list {id}.
        slots:
          id: path.id
      - text: Remove list {id} entirely.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contact-lists/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a contact list
      effect: write
      questions:
      - Can I rename a contact list or pin it to the top?
      - Is it possible to move a contact list into a different group?
      instructions:
      - text: Rename contact list {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Move list {id} into group {group}.
        slots:
          id: path.id
          group: requestBody.groupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contact-lists/reorder'].post
  update:
    x-apievangelist-phrasing:
      intent: Reorder contact lists
      effect: write
      questions:
      - Can I change the order my contact lists appear in?
      - How do I set a custom sort order for lists?
      instructions:
      - text: Reorder my contact lists as {items}.
        slots:
          items: requestBody.items
      - text: 'Apply this sort order to my contact lists: {items}.'
        slots:
          items: requestBody.items
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contact-lists/{id}/contacts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add contacts to a list
      effect: write
      questions:
      - How do I put contacts into an existing list?
      - Can I add several contacts to a list at once?
      instructions:
      - text: Add contacts {contacts} to list {id}.
        slots:
          id: path.id
          contacts: requestBody.contactIds
      - text: Put {contacts} into contact list {id}.
        slots:
          id: path.id
          contacts: requestBody.contactIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contact-lists/{id}/contacts'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove contacts from a list
      effect: destructive
      questions:
      - Can I take contacts out of a list without deleting them?
      - Does removing someone from a list delete the contact itself?
      instructions:
      - text: Remove contacts from list {id}.
        slots:
          id: path.id
      - text: Take the selected contacts out of list {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contact-lists/{id}/duplicate'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate a contact list
      effect: write
      questions:
      - Can I copy a contact list to start a new one?
      - Is there a quick way to clone a list?
      instructions:
      - text: Duplicate contact list {id}.
        slots:
          id: path.id
      - text: Make a copy of list {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contact-lists/all-statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get statistics for all contact lists
      effect: read
      questions:
      - How big is each of my contact lists?
      - Can I see statistics for every list in one view?
      instructions:
      - text: Show statistics across all my contact lists.
      - text: Summarize the size and stats of every list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contact-lists/compare'].get
  update:
    x-apievangelist-phrasing:
      intent: Compare two contact lists
      effect: read
      questions:
      - How do two of my contact lists differ in their statistics?
      - Can I put two lists side by side?
      instructions:
      - text: Compare contact list {a} with list {b}.
        slots:
          a: query.a
          b: query.b
      - text: Show stats for lists {a} and {b} side by side.
        slots:
          a: query.a
          b: query.b
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/contact-lists/{id}/statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get statistics for one contact list
      effect: read
      questions:
      - What's in a single contact list, by the numbers?
      - Where can I see one list's statistics?
      instructions:
      - text: Show statistics for contact list {id}.
        slots:
          id: path.id
      - text: Get the numbers for list {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'