ZoomInfo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ZoomInfo WebSights API

4 actions 4 updates phrasing extends openapi/zoominfo-websights-api-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/ip'].post

$.paths['/lookup/inputfields/ip/enrich'].get

$.paths['/lookup/outputfields/ip/enrich'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ZoomInfo WebSights API
  version: 1.0.0
extends: openapi/zoominfo-websights-api-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/ip'].post
  update:
    x-apievangelist-phrasing:
      intent: Identify the company behind an IP address
      effect: read
      questions:
      - Which company is visiting my website from a given IP address?
      - Can I turn an IP address into a company record?
      instructions:
      - text: Identify the company for IP {ip}.
        slots:
          ip: requestBody.ipAddress
      - text: Enrich IP address {ip} with company details.
        slots:
          ip: requestBody.ipAddress
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/inputfields/ip/enrich'].get
  update:
    x-apievangelist-phrasing:
      intent: List input fields for IP enrichment
      effect: read
      questions:
      - What can I send to identify a website visitor's company besides the IP?
      - Which inputs does IP enrich accept?
      instructions:
      - text: List the input fields for IP enrich.
      - text: Show what the IP lookup can match on.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/outputfields/ip/enrich'].get
  update:
    x-apievangelist-phrasing:
      intent: List output fields for IP enrichment
      effect: read
      questions:
      - Which company and location fields can come back from an IP lookup?
      - What output columns does IP enrich offer?
      instructions:
      - text: List the output fields for IP enrich.
      - text: Show which visitor company attributes IP enrichment returns.
      method: generated
      generated: '2026-09-26'