Zoho CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Records Search API

2 actions 2 updates phrasing extends openapi/zoho-crm-search-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['/{module}/search'].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 Records Search API
  version: 1.0.0
extends: openapi/zoho-crm-search-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['/{module}/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search records in a module
      effect: read
      questions:
      - How do I find leads by email address or phone number?
      - Can I search a module with several field conditions combined with AND/OR?
      - What's the maximum number of records a search can return?
      instructions:
      - text: Search {module} for records with email {email}.
        slots:
          module: path.module
          email: query.email
      - text: Find {module} records matching the criteria {criteria}.
        slots:
          module: path.module
          criteria: query.criteria
      - text: Search {module} for the word {word}.
        slots:
          module: path.module
          word: query.word
      - text: Look up {module} records by phone number {phone}.
        slots:
          module: path.module
          phone: query.phone
      method: generated
      generated: '2026-09-26'