Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Companies / Duplicates API

6 actions 6 updates phrasing extends openapi/live-direct-marketing-online-companies-duplicates-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/companies/duplicates/fields'].get
$.paths['/api/companies/duplicates/scan'].post
$.paths['/api/companies/duplicates/merge'].post
$.paths['/api/companies/duplicates/delete'].post
$.paths['/api/companies/duplicates/move-to-list'].post

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 Companies / Duplicates API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-companies-duplicates-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/companies/duplicates/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List fields usable for duplicate matching
      effect: read
      questions:
      - Which company fields can I match on when looking for duplicates?
      - Can duplicate detection compare on website or tax id fields?
      instructions:
      - text: List the company fields available for duplicate matching.
      - text: Show which fields I can pick when configuring a duplicate company scan.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/duplicates/scan'].post
  update:
    x-apievangelist-phrasing:
      intent: Scan companies for duplicates
      effect: read
      questions:
      - How do I find duplicate company records in my database?
      - Are there companies that share the same domain in my CRM?
      instructions:
      - text: Scan my companies for duplicates using the configured fields.
      - text: Run a duplicate check across my company records and show the groups found.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/duplicates/merge'].post
  update:
    x-apievangelist-phrasing:
      intent: Merge duplicate company records
      effect: destructive
      questions:
      - How do I combine duplicate companies into a single record?
      - Can I merge two company records that a duplicate scan flagged?
      instructions:
      - text: Merge the duplicate company records from the scan into one.
      - text: Combine the flagged duplicate companies into a single surviving record.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/duplicates/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete duplicate company records
      effect: destructive
      questions:
      - Can I just delete the extra copies of companies found by the duplicate scan?
      - How do I clean out redundant company records instead of merging them?
      instructions:
      - text: Delete the duplicate company records the scan identified.
      - text: Remove the redundant company copies from my database without merging.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/companies/duplicates/move-to-list'].post
  update:
    x-apievangelist-phrasing:
      intent: Move duplicate companies into a list
      effect: write
      questions:
      - Can I put duplicate companies into a separate list for manual review?
      - How do I park flagged duplicates in a target company list?
      instructions:
      - text: Move the duplicate companies from the scan into a review list.
      - text: Send all flagged duplicate company records to a target list instead of deleting them.
      method: generated
      generated: '2026-10-01'