ZoomInfo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Platform API V1 Engagements API

4 actions 4 updates phrasing extends openapi/zoominfo-engagements-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['/platform/v1/engagements/content-interactions'].post

$.paths['/platform/v1/engagements/content-interactions/{id}'].get

$.paths['/platform/v1/engagements/content-interactions/{id}'].delete

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 Platform API V1 Engagements API
  version: 1.0.0
extends: openapi/zoominfo-engagements-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['/platform/v1/engagements/content-interactions'].post
  update:
    x-apievangelist-phrasing:
      intent: Record content interactions
      effect: write
      questions:
      - How do I send content engagement activity like downloads into ZoomInfo?
      - Can I update content interaction records I already sent?
      instructions:
      - text: Record these content interactions {interactions}.
        slots:
          interactions: requestBody.data
      - text: Upsert content engagement records {interactions}.
        slots:
          interactions: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/v1/engagements/content-interactions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a content interaction
      effect: read
      questions:
      - Can I look up a single content interaction record?
      - What was stored for one content engagement?
      instructions:
      - text: Get content interaction {id}.
        slots:
          id: path.id
      - text: Show the engagement record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/v1/engagements/content-interactions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a content interaction
      effect: destructive
      questions:
      - How do I remove a content interaction I recorded by mistake?
      - Can I delete one content engagement record?
      instructions:
      - text: Delete content interaction {id}.
        slots:
          id: path.id
      - text: Remove engagement record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'