# 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 Lists API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-company-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: 10
- target: $.paths['/api/company-lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List company lists
      effect: read
      questions:
      - Which company lists do I have in my workspace?
      - Can I see all my saved account lists?
      instructions:
      - text: List all my company lists.
      - text: Show every company list in this tenant.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/company-lists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a company list
      effect: write
      questions:
      - How do I create a new list to group target companies?
      - Can I make a smart company list driven by filters?
      instructions:
      - text: Create a company list named {name}.
        slots:
          name: requestBody.name
      - text: Create a smart company list {name} with filters {smartFilters}.
        slots:
          name: requestBody.name
          smartFilters: requestBody.smartFilters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/company-lists/contacts-counts'].get
  update:
    x-apievangelist-phrasing:
      intent: Count contacts behind each company list
      effect: read
      questions:
      - How many contacts belong to the companies in each of my lists?
      - Can I get contact totals for several company lists in one call?
      instructions:
      - text: Count contacts of member companies for lists {ids}.
        slots:
          ids: query.ids
      - text: Show contact totals per company list for {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/company-lists/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a company list
      effect: destructive
      questions:
      - Can I delete a company list I no longer use?
      - Does deleting a company list remove the companies themselves?
      instructions:
      - text: Delete company list {id}.
        slots:
          id: path.id
      - text: Remove the company list {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/company-lists/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a company list
      effect: write
      questions:
      - Can I rename a company list or pin it to the top?
      - Is it possible to move a company list into a different group?
      instructions:
      - text: Rename company list {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Move company list {id} into group {groupId}.
        slots:
          id: path.id
          groupId: requestBody.groupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/company-lists/reorder'].post
  update:
    x-apievangelist-phrasing:
      intent: Reorder company lists
      effect: write
      questions:
      - Can I change the order my company lists appear in?
      - What does it take to set a custom sort order on my lists?
      instructions:
      - text: Reorder my company lists as {items}.
        slots:
          items: requestBody.items
      - text: Apply sort order {items} to company lists.
        slots:
          items: requestBody.items
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/company-lists/{id}/companies'].post
  update:
    x-apievangelist-phrasing:
      intent: Add companies to a list
      effect: write
      questions:
      - How do I put specific companies into one of my lists?
      - Can I add several companies to a list at once?
      instructions:
      - text: Add companies {companyIds} to list {id}.
        slots:
          companyIds: requestBody.companyIds
          id: path.id
      - text: Put {companyIds} into company list {id}.
        slots:
          companyIds: requestBody.companyIds
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/company-lists/{id}/companies'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove companies from a list
      effect: destructive
      questions:
      - Can I take companies out of a list without deleting them?
      - What happens to companies removed from a company list?
      instructions:
      - text: Remove companies from list {id}.
        slots:
          id: path.id
      - text: Take member companies out of company list {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/company-lists/{id}/merge'].post
  update:
    x-apievangelist-phrasing:
      intent: Merge one company list into another
      effect: write
      questions:
      - Can I fold one company list into another, either moving or copying its companies?
      - What happens to duplicate companies when lists are merged?
      instructions:
      - text: Merge company list {id} into {targetId} using mode {mode}.
        slots:
          id: path.id
          targetId: requestBody.targetId
          mode: requestBody.mode
      - text: Copy all companies from list {id} into list {targetId}, setting mode to {mode}.
        slots:
          id: path.id
          targetId: requestBody.targetId
          mode: requestBody.mode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/company-lists/{id}/duplicate'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate a company list
      effect: write
      questions:
      - Can I make a copy of an existing company list?
      - Is there a quick way to clone a list before editing it?
      instructions:
      - text: Duplicate company list {id}.
        slots:
          id: path.id
      - text: Clone the company list {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'