# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Data API V1 Enrich API
  version: 1.0.0
extends: openapi/zoominfo-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: 9
- target: $.paths['/data/v1/contacts/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Enrich up to 25 contacts
      effect: read
      questions:
      - How do I get full profile details for people I found in a contact search?
      - Can I enrich several contacts in one call, and what's the limit?
      instructions:
      - text: Enrich these contacts {contacts}.
        slots:
          contacts: requestBody.data
      - text: Get emails, phones and titles for the people {contacts}.
        slots:
          contacts: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/companies/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Enrich up to 25 companies
      effect: read
      questions:
      - How do I get detailed firmographics for companies from my search results?
      - Can I enrich a company by its website domain?
      instructions:
      - text: Enrich these companies {companies}.
        slots:
          companies: requestBody.data
      - text: Get revenue, headcount and industry for {companies}.
        slots:
          companies: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/companies/corporate-hierarchy/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Get corporate family trees for companies
      effect: read
      questions:
      - Which parent company and subsidiaries belong to an account?
      - Can I pull the full corporate hierarchy for several companies at once?
      instructions:
      - text: Get the corporate hierarchy for {companies}.
        slots:
          companies: requestBody.data
      - text: Show the full family tree of {companies}.
        slots:
          companies: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/intent/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Get buyer intent signals for a company
      effect: read
      questions:
      - What topics is a particular company showing buyer intent for?
      - Can I sort a company's intent signals by score?
      instructions:
      - text: Get intent signals for company {company}.
        slots:
          company: requestBody.data
      - text: Show page {page} of intent signals for {company} sorted by {sort}.
        slots:
          page: query.page[number]
          company: requestBody.data
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/news/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Get news articles about a company
      effect: read
      questions:
      - What's been in the news lately about one of my accounts?
      - Can I pull a specific company's news by website instead of ID?
      instructions:
      - text: Get news articles about company {company}.
        slots:
          company: requestBody.data
      - text: Show {size} recent news items for {company}.
        slots:
          size: query.page[size]
          company: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/companies/org-chart/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a company's org chart by department
      effect: read
      questions:
      - Who sits in a given department at a company, organized by seniority?
      - Can I find the decision makers in one department of an account?
      instructions:
      - text: Get the org chart for {request}.
        slots:
          request: requestBody.data
      - text: List contacts in the requested department at {request}, sorted by {sort}.
        slots:
          request: requestBody.data
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/scoops/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Get scoops for a company
      effect: read
      questions:
      - What scoops, like funding or leadership changes, exist for one account?
      - Can I filter a company's scoops to a date range?
      instructions:
      - text: Get scoops for company {company}.
        slots:
          company: requestBody.data
      - text: Show page {page} of scoops for {company}.
        slots:
          page: query.page[number]
          company: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/companies/technologies/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the technologies a company uses
      effect: read
      questions:
      - What technologies has ZoomInfo detected at a company?
      - Does a given account run a particular piece of software?
      instructions:
      - text: List the technologies used by {company}.
        slots:
          company: requestBody.data
      - text: Show the tech stack ZoomInfo has for {company}.
        slots:
          company: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/companies/hashtags/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a company's hashtags
      effect: read
      questions:
      - Which hashtags classify a company's business characteristics?
      - Can I see the category labels ZoomInfo assigns to an account?
      instructions:
      - text: Get hashtags for company {company}.
        slots:
          company: requestBody.data
      - text: List the category hashtags attached to {company}.
        slots:
          company: requestBody.data
      method: generated
      generated: '2026-09-26'