Zoho CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Coql API

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

$.info

$.paths['/coql'].post

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 Coql API
  version: 1.0.0
extends: openapi/zoho-crm-coql-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: 1
- target: $.paths['/coql'].post
  update:
    x-apievangelist-phrasing:
      intent: Query records with a COQL select
      effect: read
      questions:
      - Can I fetch CRM records with a SQL-like select query?
      - How do I include field metadata in COQL query results?
      instructions:
      - text: Run the COQL query {select_query}.
        slots:
          select_query: requestBody.select_query
      - text: Execute {select_query} and include metadata {include_meta}.
        slots:
          select_query: requestBody.select_query
          include_meta: requestBody.include_meta
      method: generated
      generated: '2026-09-26'