Zoho CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zoho CRM Related Records API

7 actions 7 updates phrasing extends openapi/zoho-crm-zoho-crm-related-records-api-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 7

$.info
$.paths['/{parentRecordModule}/{parentRecord}/{relatedList}'].get
$.paths['/{parentRecordModule}/{parentRecord}/{relatedList}'].put
$.paths['/{parentRecordModule}/{parentRecord}/{relatedList}'].delete
$.paths['/{parentRecordModule}/{parentRecord}/{relatedList}/{record}'].get
$.paths['/{parentRecordModule}/{parentRecord}/{relatedList}/{record}'].put
$.paths['/{parentRecordModule}/{parentRecord}/{relatedList}/{record}'].delete

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 Related Records API
  version: 1.0.0
extends: openapi/zoho-crm-zoho-crm-related-records-api-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: 6
- target: $.paths['/{parentRecordModule}/{parentRecord}/{relatedList}'].get
  update:
    x-apievangelist-phrasing:
      intent: List records in a record's related list
      effect: read
      questions:
      - How do I see all the records in a related list, such as the contacts under an account?
      - Can I fetch only related records changed since a certain time?
      - Is it possible to list only converted records in a related list?
      instructions:
      - text: List the {relatedList} related to {parentRecordModule} record {parentRecord}, returning {fields}.
        slots:
          relatedList: path.relatedList
          parentRecordModule: path.parentRecordModule
          parentRecord: path.parentRecord
          fields: query.fields
      - text: Show {fields} for {relatedList} of record {parentRecord} in {parentRecordModule} modified since {since}.
        slots:
          fields: query.fields
          relatedList: path.relatedList
          parentRecord: path.parentRecord
          parentRecordModule: path.parentRecordModule
          since: header.If-Modified-Since
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{parentRecordModule}/{parentRecord}/{relatedList}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update several related records
      effect: write
      questions:
      - Can I update properties on multiple records in one related list at once?
      - What's the way to bulk edit the relation details under a parent record?
      instructions:
      - text: 'Update these {relatedList} under {parentRecordModule} record {parentRecord}: {data}.'
        slots:
          relatedList: path.relatedList
          parentRecordModule: path.parentRecordModule
          parentRecord: path.parentRecord
          data: requestBody.data
      - text: Bulk edit the related {relatedList} of record {parentRecord} in {parentRecordModule}.
        slots:
          relatedList: path.relatedList
          parentRecord: path.parentRecord
          parentRecordModule: path.parentRecordModule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{parentRecordModule}/{parentRecord}/{relatedList}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink several related records
      effect: destructive
      questions:
      - Can I unlink multiple records from a parent without deleting the records themselves?
      - How do I remove a batch of relationships from a related list by ID?
      instructions:
      - text: Delink {ids} from the {relatedList} of {parentRecordModule} record {parentRecord}.
        slots:
          ids: query.ids
          relatedList: path.relatedList
          parentRecordModule: path.parentRecordModule
          parentRecord: path.parentRecord
      - text: 'Remove the links between record {parentRecord} in {parentRecordModule} and these {relatedList}: {ids}.'
        slots:
          parentRecord: path.parentRecord
          parentRecordModule: path.parentRecordModule
          relatedList: path.relatedList
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{parentRecordModule}/{parentRecord}/{relatedList}/{record}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one specific related record
      effect: read
      questions:
      - Where can I read a single record through its parent's related list?
      - Is a particular record actually linked to this parent, and what are its fields?
      instructions:
      - text: Get related record {record} from {relatedList} of {parentRecordModule} record {parentRecord}, returning {fields}.
        slots:
          record: path.record
          relatedList: path.relatedList
          parentRecordModule: path.parentRecordModule
          parentRecord: path.parentRecord
          fields: query.fields
      - text: Show {fields} of {record} as related to record {parentRecord} in {parentRecordModule} via {relatedList}.
        slots:
          fields: query.fields
          record: path.record
          parentRecord: path.parentRecord
          parentRecordModule: path.parentRecordModule
          relatedList: path.relatedList
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{parentRecordModule}/{parentRecord}/{relatedList}/{record}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one specific related record
      effect: write
      questions:
      - Can I edit the relation details for just one related record?
      - What's the way to update a single linked record under a parent?
      instructions:
      - text: Update related record {record} in {relatedList} of {parentRecordModule} record {parentRecord} with {data}.
        slots:
          record: path.record
          relatedList: path.relatedList
          parentRecordModule: path.parentRecordModule
          parentRecord: path.parentRecord
          data: requestBody.data
      - text: Edit only the link to {record} under record {parentRecord} in {parentRecordModule}'s {relatedList}.
        slots:
          record: path.record
          parentRecord: path.parentRecord
          parentRecordModule: path.parentRecordModule
          relatedList: path.relatedList
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{parentRecordModule}/{parentRecord}/{relatedList}/{record}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink one related record
      effect: destructive
      questions:
      - How do I unlink a single record from its parent without deleting it?
      - Can I remove just one association from a related list?
      instructions:
      - text: Unlink the single related record {record} so it no longer sits under {parentRecordModule} {parentRecord} in {relatedList}.
        slots:
          record: path.record
          relatedList: path.relatedList
          parentRecordModule: path.parentRecordModule
          parentRecord: path.parentRecord
      - text: Break only the link between {record} and record {parentRecord} in {parentRecordModule}'s {relatedList}.
        slots:
          record: path.record
          parentRecord: path.parentRecord
          parentRecordModule: path.parentRecordModule
          relatedList: path.relatedList
      method: generated
      generated: '2026-09-26'