Zoho CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bulk Read API

4 actions 4 updates phrasing extends openapi/zoho-crm-read-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['/read'].post

$.paths['/read/{jobId}'].get

$.paths['/read/{jobId}/result'].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 Bulk Read API
  version: 1.0.0
extends: openapi/zoho-crm-read-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['/read'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a bulk export job
      effect: write
      questions:
      - How do I export a large number of CRM records in one background job?
      - Can I get a callback when a bulk read finishes, and choose the file type?
      instructions:
      - text: Start a bulk read job with query {query}.
        slots:
          query: requestBody.query
      - text: Create a bulk export for {query} as a {file_type} file and notify {callback}.
        slots:
          query: requestBody.query
          file_type: requestBody.file_type
          callback: requestBody.callback
      method: generated
      generated: '2026-09-26'
- target: $.paths['/read/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk export job's status
      effect: read
      questions:
      - Has my bulk read job finished yet?
      - What's the current state of a bulk export I started?
      instructions:
      - text: Check the status of bulk read job {jobId}.
        slots:
          jobId: path.jobId
      - text: Show details for bulk export job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/read/{jobId}/result'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a bulk export's result file
      effect: read
      questions:
      - Where do I download the exported file from a completed bulk read?
      - Can I fetch the result of a bulk export job once it's done?
      instructions:
      - text: Download the result of bulk read job {jobId}.
        slots:
          jobId: path.jobId
      - text: Get the exported file for job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'