ZoomInfo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ZoomInfo Compliance API

4 actions 4 updates phrasing extends openapi/zoominfo-compliance-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['/compliance'].post
$.paths['/lookup/inputfields/compliance/enrich'].get
$.paths['/lookup/outputfields/compliance/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 Compliance API
  version: 1.0.0
extends: openapi/zoominfo-compliance-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['/compliance'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a contact's compliance status
      effect: read
      questions:
      - Can I check whether a contact has opted out or is compliant to reach?
      - What compliance details does ZoomInfo hold on a person?
      instructions:
      - text: Check compliance details for {person}.
        slots:
          person: requestBody.matchPersonInput
      - text: Tell me if I can contact {person} under compliance rules.
        slots:
          person: requestBody.matchPersonInput
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/inputfields/compliance/enrich'].get
  update:
    x-apievangelist-phrasing:
      intent: List input fields for compliance lookups
      effect: read
      questions:
      - What can I use to identify a person for a compliance lookup?
      - Which inputs does the compliance endpoint accept?
      instructions:
      - text: List the input fields for the compliance lookup.
      - text: Show which person identifiers compliance matching takes.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/outputfields/compliance/enrich'].get
  update:
    x-apievangelist-phrasing:
      intent: List fields returned by compliance lookups
      effect: read
      questions:
      - Which compliance details come back for a matched person?
      - What does a compliance response contain?
      instructions:
      - text: List the fields the compliance lookup returns.
      - text: Show every compliance attribute in the response.
      method: generated
      generated: '2026-09-26'