Zoho CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bulk Write API

3 actions 3 updates phrasing extends openapi/zoho-crm-write-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 3

$.info
$.paths['/write'].post
$.paths['/write/{jobId}'].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 Bulk Write API
  version: 1.0.0
extends: openapi/zoho-crm-write-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: 2
- target: $.paths['/write'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a bulk import job
      effect: write
      questions:
      - How do I import thousands of records from a CSV in one job?
      - Can I get a callback when a bulk write job finishes?
      instructions:
      - text: Create a bulk {operation} job for resources {resource}.
        slots:
          operation: requestBody.operation
          resource: requestBody.resource
      - text: Start a bulk write job and call {callback} when it's done.
        slots:
          callback: requestBody.callback
      method: generated
      generated: '2026-09-26'
- target: $.paths['/write/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk write job
      effect: read
      questions:
      - How do I check the progress of a bulk write job?
      - Where do I find the results of a bulk import?
      instructions:
      - text: Get bulk write job {jobId}.
        slots:
          jobId: path.jobId
      - text: Show status of bulk import {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'