ZoomInfo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Copilot API V1 Products and Services API

7 actions 7 updates phrasing extends openapi/zoominfo-products-and-services-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for ZoomInfo's API. It is a proposal applied on top of the contract, not a document ZoomInfo publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/copilot/v1/products'].get
$.paths['/copilot/v1/products'].post
$.paths['/copilot/v1/products/{offeringId}'].get
$.paths['/copilot/v1/products/{offeringId}'].delete
$.paths['/copilot/v1/products/{offeringId}/actions/archive'].post
$.paths['/copilot/v1/products/{offeringId}/actions/unarchive'].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 Copilot API V1 Products and Services API
  version: 1.0.0
extends: openapi/zoominfo-products-and-services-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/products'].get
  update:
    x-apievangelist-phrasing:
      intent: List my products and services
      effect: read
      questions:
      - Which products and services have we configured for go-to-market?
      - Can I see everything we sell as ZoomInfo has it recorded?
      instructions:
      - text: List our products and services.
      - text: Show every product or service configured for my company.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/copilot/v1/products'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a product or service
      effect: write
      questions:
      - How do I add a product we sell to our GTM configuration?
      - Can I update the value proposition on an existing product?
      instructions:
      - text: Add a product or service {offering}.
        slots:
          offering: requestBody.data
      - text: Update the product record with {offering}.
        slots:
          offering: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/copilot/v1/products/{offeringId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product or service
      effect: read
      questions:
      - What's recorded about one of our products or services?
      - Can I look up a single product or service by ID?
      instructions:
      - text: Show product or service {offeringId}.
        slots:
          offeringId: path.offeringId
      - text: Get the details of offering {offeringId}.
        slots:
          offeringId: path.offeringId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/copilot/v1/products/{offeringId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a product or service
      effect: destructive
      questions:
      - Can I permanently delete a product we no longer sell?
      - Is deleting a product or service a hard delete?
      instructions:
      - text: Permanently delete offering {offeringId}.
        slots:
          offeringId: path.offeringId
      - text: Remove product {offeringId} for good.
        slots:
          offeringId: path.offeringId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/copilot/v1/products/{offeringId}/actions/archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive a product or service
      effect: write
      questions:
      - How do I hide a discontinued product but keep its record?
      - Does archiving a product remove it from the list?
      instructions:
      - text: Archive offering {offeringId}.
        slots:
          offeringId: path.offeringId
      - text: Hide product {offeringId} from the list without deleting it.
        slots:
          offeringId: path.offeringId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/copilot/v1/products/{offeringId}/actions/unarchive'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore an archived product or service
      effect: write
      questions:
      - Can I bring back a product I archived?
      - How do I reactivate an archived offering?
      instructions:
      - text: Unarchive offering {offeringId}.
        slots:
          offeringId: path.offeringId
      - text: Restore archived product {offeringId}.
        slots:
          offeringId: path.offeringId
      method: generated
      generated: '2026-09-26'