# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Copilot API V1 Customer Competitors API
  version: 1.0.0
extends: openapi/zoominfo-customer-competitors-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/copilot/v1/customer-competitors'].get
  update:
    x-apievangelist-phrasing:
      intent: List my tracked competitors
      effect: read
      questions:
      - Which competitors have we recorded in our competitive intelligence?
      - Can I see every competitor configured for my company?
      instructions:
      - text: List our competitors.
      - text: Show all the competitor records we've set up.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/copilot/v1/customer-competitors'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a competitor record
      effect: write
      questions:
      - How do I add a competitor with the products they compete on?
      - Can I update a few attributes of an existing competitor record?
      instructions:
      - text: Add a competitor {competitor}.
        slots:
          competitor: requestBody.data
      - text: Update the competitor record with {competitor}.
        slots:
          competitor: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/copilot/v1/customer-competitors/{competitorId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a competitor record
      effect: read
      questions:
      - What competitive intelligence do we have on one competitor?
      - Can I look up a single competitor by its ID?
      instructions:
      - text: Show competitor {competitorId}.
        slots:
          competitorId: path.competitorId
      - text: Get the competing products and notes for competitor {competitorId}.
        slots:
          competitorId: path.competitorId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/copilot/v1/customer-competitors/{competitorId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a competitor record
      effect: destructive
      questions:
      - Can I permanently delete a competitor record?
      - Is removing a competitor a hard delete that can't be undone?
      instructions:
      - text: Permanently delete competitor {competitorId}.
        slots:
          competitorId: path.competitorId
      - text: Remove competitor {competitorId} for good.
        slots:
          competitorId: path.competitorId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/copilot/v1/customer-competitors/{competitorId}/actions/archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive a competitor record
      effect: write
      questions:
      - How do I hide a competitor but keep it for audit history?
      - Does an archived competitor still count toward limits?
      instructions:
      - text: Archive competitor {competitorId}.
        slots:
          competitorId: path.competitorId
      - text: Hide competitor {competitorId} from the list without deleting it.
        slots:
          competitorId: path.competitorId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/copilot/v1/customer-competitors/{competitorId}/actions/unarchive'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore an archived competitor
      effect: write
      questions:
      - Can I bring back a competitor I archived?
      - How do I reactivate an archived competitor record?
      instructions:
      - text: Unarchive competitor {competitorId}.
        slots:
          competitorId: path.competitorId
      - text: Restore archived competitor {competitorId}.
        slots:
          competitorId: path.competitorId
      method: generated
      generated: '2026-09-26'