ZoomInfo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ZoomInfo Scoop Enrich API

4 actions 4 updates phrasing extends openapi/zoominfo-scoop-enrich-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 4

$.info
$.paths['/enrich/scoop'].post
$.paths['/lookup/inputfields/scoop/enrich'].get
$.paths['/lookup/outputfields/scoop/enrich'].get

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 ZoomInfo Scoop Enrich API
  version: 1.0.0
extends: openapi/zoominfo-scoop-enrich-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: 3
- target: $.paths['/enrich/scoop'].post
  update:
    x-apievangelist-phrasing:
      intent: Get scoops about a company
      effect: read
      questions:
      - What scoops like leadership moves or projects exist for one company?
      - Can I filter a company's scoops by type and published date?
      instructions:
      - text: Get scoops for {company}.
        slots:
          company: requestBody.companyName
      - text: Show {scoopType} scoops about {company} published since {start}.
        slots:
          scoopType: requestBody.scoopType
          company: requestBody.companyName
          start: requestBody.publishedStartDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/inputfields/scoop/enrich'].get
  update:
    x-apievangelist-phrasing:
      intent: List input fields for scoop enrichment
      effect: read
      questions:
      - Which inputs can I use when pulling scoops for one company?
      - What parameters does scoop enrich accept?
      instructions:
      - text: List the input fields for scoop enrich.
      - text: Show the filters available when enriching a company's scoops.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/outputfields/scoop/enrich'].get
  update:
    x-apievangelist-phrasing:
      intent: List output fields for scoop enrichment
      effect: read
      questions:
      - Which scoop fields come back when I enrich a company?
      - What output columns does scoop enrich offer?
      instructions:
      - text: List the output fields for scoop enrich.
      - text: Show which scoop attributes the enrichment returns.
      method: generated
      generated: '2026-09-26'