Zoho CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zoho Crm Deleted API

3 actions 3 updates phrasing extends openapi/zoho-crm-deleted-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['/{module}/deleted'].get
$.paths['/{parentRecordModule}/deleted/{parentRecord}/{relatedList}'].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 Zoho Crm Deleted API
  version: 1.0.0
extends: openapi/zoho-crm-deleted-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['/{module}/deleted'].get
  update:
    x-apievangelist-phrasing:
      intent: List deleted records in a module
      effect: read
      questions:
      - How do I see which records were deleted from a module?
      - Can I list only records still in the recycle bin versus permanently deleted ones?
      instructions:
      - text: List deleted records in {module}.
        slots:
          module: path.module
      - text: Show {module} records of deletion type {type}.
        slots:
          module: path.module
          type: query.type
      - text: Get page {page} of deleted {module} records with {per_page} per page.
        slots:
          page: query.page
          module: path.module
          per_page: query.per_page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{parentRecordModule}/deleted/{parentRecord}/{relatedList}'].get
  update:
    x-apievangelist-phrasing:
      intent: List deleted records once related to a record
      effect: read
      questions:
      - Which records that were linked to this account have since been deleted?
      - Can I audit deleted items from one parent record's related list?
      instructions:
      - text: List deleted {relatedList} that were related to {parentRecordModule} record {parentRecord}, returning {fields}.
        slots:
          relatedList: path.relatedList
          parentRecordModule: path.parentRecordModule
          parentRecord: path.parentRecord
          fields: query.fields
      - text: Show {fields} of removed {relatedList} once linked to record {parentRecord} in {parentRecordModule}.
        slots:
          fields: query.fields
          relatedList: path.relatedList
          parentRecord: path.parentRecord
          parentRecordModule: path.parentRecordModule
      method: generated
      generated: '2026-09-26'