API Evangelist conversational phrasing for Zoho Crm Records API

# 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 Records API
  version: 1.0.0
extends: openapi/zoho-crm-records-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: 8
- target: $.paths['/{moduleApiName}/actions/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count records in a module
      effect: read
      questions:
      - How many leads do I have in Zoho CRM right now?
      - Can I count only the records that match an email, phone number or search criteria?
      - Is it possible to count just the records in one custom view?
      instructions:
      - text: Count the records in {moduleApiName}.
        slots:
          moduleApiName: path.moduleApiName
      - text: Count {moduleApiName} records in custom view {cvid}.
        slots:
          moduleApiName: path.moduleApiName
          cvid: query.cvid
      - text: Count {moduleApiName} records matching criteria {criteria}.
        slots:
          moduleApiName: path.moduleApiName
          criteria: query.criteria
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{module}'].get
  update:
    x-apievangelist-phrasing:
      intent: List records in a module
      effect: read
      questions:
      - How do I pull a list of all deals with just a few fields?
      - Can I page through contacts sorted by a field of my choosing?
      - Which records belong to a given territory?
      instructions:
      - text: List {module} records with fields {fields}.
        slots:
          module: path.module
          fields: query.fields
      - text: Get {module} records in custom view {cvid}, {per_page} per page.
        slots:
          module: path.module
          cvid: query.cvid
          per_page: query.per_page
      - text: List {module} records sorted by {sort_by}.
        slots:
          module: path.module
          sort_by: query.sort_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{module}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update several records in one request
      effect: write
      questions:
      - How do I update a batch of existing records in one API call?
      - Can I bulk edit contacts and still trigger workflow rules?
      instructions:
      - text: Update these {module} records with {data}.
        slots:
          module: path.module
          data: requestBody.data
      - text: Apply the batch of field changes to multiple {module} records.
        slots:
          module: path.module
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{module}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create records in a module
      effect: write
      questions:
      - How do I add a new lead to Zoho CRM from my web form?
      - Can I insert several new contacts in a single request?
      instructions:
      - text: Create a new {module} record with {data}.
        slots:
          module: path.module
          data: requestBody.data
      - text: Add these new entries to {module} without triggering workflows.
        slots:
          module: path.module
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{module}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several records at once
      effect: destructive
      questions:
      - How do I permanently delete a handful of records by their IDs?
      - Does deleting multiple records return a result for each one?
      instructions:
      - text: Delete {module} records {ids}.
        slots:
          module: path.module
          ids: query.ids
      - text: Permanently remove this list of {module} records.
        slots:
          module: path.module
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{module}/{recordID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one record by ID
      effect: read
      questions:
      - How do I look up all the details of one specific contact?
      - What does a single deal record look like when I fetch it by ID?
      instructions:
      - text: Get {module} record {recordID}.
        slots:
          module: path.module
          recordID: path.recordID
      - text: Show everything on record {recordID} in {module}.
        slots:
          module: path.module
          recordID: path.recordID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{module}/{recordID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one record by ID
      effect: write
      questions:
      - How do I change fields on one specific lead?
      - Can I edit a single record and skip automation from firing?
      instructions:
      - text: Update {module} record {recordID} with {data}.
        slots:
          module: path.module
          recordID: path.recordID
          data: requestBody.data
      - text: Change the fields on record {recordID} in {module}.
        slots:
          module: path.module
          recordID: path.recordID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{module}/{recordID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one record by ID
      effect: destructive
      questions:
      - How do I delete a single contact record?
      - Is deleting one deal by its ID permanent?
      instructions:
      - text: Delete {module} record {recordID}.
        slots:
          module: path.module
          recordID: path.recordID
      - text: Permanently remove record {recordID} from {module}.
        slots:
          module: path.module
          recordID: path.recordID
      method: generated
      generated: '2026-09-26'