Zoho CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ZIA Organization Enrichment Zia Org Enrichment API

4 actions 4 updates phrasing extends openapi/zoho-crm-zia-org-enrichment-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Zoho CRM's API. It is a proposal applied on top of the contract, not a document Zoho CRM publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/__zia_org_enrichment'].get
$.paths['/__zia_org_enrichment'].post
$.paths['/__zia_org_enrichment/{id}'].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 ZIA Organization Enrichment Zia Org Enrichment API
  version: 1.0.0
extends: openapi/zoho-crm-zia-org-enrichment-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['/__zia_org_enrichment'].get
  update:
    x-apievangelist-phrasing:
      intent: List Zia organization enrichment jobs
      effect: read
      questions:
      - Which organization enrichment requests has Zia processed?
      - Can I filter enrichment jobs to only the failed ones?
      instructions:
      - text: List Zia org enrichment records with status {status}.
        slots:
          status: query.status
      - text: Show my recent organization enrichment requests.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/__zia_org_enrichment'].post
  update:
    x-apievangelist-phrasing:
      intent: Enrich a record's company data with Zia
      effect: write
      questions:
      - How do I have Zia fill in company details for an account from its website?
      - Which input fields does organization enrichment accept?
      instructions:
      - text: Enrich {module} record {record_id} with organization data.
        slots:
          module: query.module
          record_id: query.record_id
      - text: Start Zia org enrichment in {module} using {__zia_org_enrichment}.
        slots:
          module: query.module
          __zia_org_enrichment: requestBody.__zia_org_enrichment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/__zia_org_enrichment/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the result of an organization enrichment
      effect: read
      questions:
      - How do I see the enriched company data from one enrichment job?
      - Did a specific Zia enrichment complete or fail?
      instructions:
      - text: Get org enrichment {id}.
        slots:
          id: path.id
      - text: Show the enriched fields and status of enrichment job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'