# 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 Ideal Customer Profile API
  version: 1.0.0
extends: openapi/zoominfo-ideal-customer-profile-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/ideal-company-profile'].get
  update:
    x-apievangelist-phrasing:
      intent: List my ideal customer profiles
      effect: read
      questions:
      - Which ideal customer profiles have we defined?
      - Can I see all our ICP segments at once?
      instructions:
      - text: List our ideal customer profiles.
      - text: Show every ICP segment configured for my company.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/copilot/v1/ideal-company-profile'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update an ideal customer profile
      effect: write
      questions:
      - How do I define a new ideal customer profile by industry and size?
      - Can I update part of an existing ICP without replacing it?
      instructions:
      - text: Create an ideal customer profile {icp}.
        slots:
          icp: requestBody.data
      - text: Update the ICP with these attributes {icp}.
        slots:
          icp: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/copilot/v1/ideal-company-profile/{segmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an ideal customer profile
      effect: read
      questions:
      - What firmographics are defined on one of our ICPs?
      - Can I look up a single ideal customer profile by ID?
      instructions:
      - text: Show ideal customer profile {segmentId}.
        slots:
          segmentId: path.segmentId
      - text: Get the target attributes of ICP {segmentId}.
        slots:
          segmentId: path.segmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/copilot/v1/ideal-company-profile/{segmentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete an ideal customer profile
      effect: destructive
      questions:
      - Can I permanently delete an ICP segment?
      - Is deleting an ideal customer profile irreversible?
      instructions:
      - text: Permanently delete ICP {segmentId}.
        slots:
          segmentId: path.segmentId
      - text: Remove ideal customer profile {segmentId} for good.
        slots:
          segmentId: path.segmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/copilot/v1/ideal-company-profile/{segmentId}/actions/archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive an ideal customer profile
      effect: write
      questions:
      - How do I retire an ICP but keep it for reference?
      - Does archiving an ICP hide it from the list?
      instructions:
      - text: Archive ICP {segmentId}.
        slots:
          segmentId: path.segmentId
      - text: Hide ideal customer profile {segmentId} without deleting it.
        slots:
          segmentId: path.segmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/copilot/v1/ideal-company-profile/{segmentId}/actions/unarchive'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore an archived ideal customer profile
      effect: write
      questions:
      - Can I bring back an ICP I archived?
      - How do I use an archived ideal customer profile for targeting again?
      instructions:
      - text: Unarchive ICP {segmentId}.
        slots:
          segmentId: path.segmentId
      - text: Restore archived ideal customer profile {segmentId}.
        slots:
          segmentId: path.segmentId
      method: generated
      generated: '2026-09-26'