Zoho CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Attachments API

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

$.info
$.paths['/{moduleApiName}/{recordId}/Attachments/{id}'].get
$.paths['/{moduleApiName}/{recordId}/Attachments/{id}'].delete
$.paths['/{moduleApiName}/{recordId}/Attachments'].get
$.paths['/{moduleApiName}/{recordId}/Attachments'].post

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 Attachments API
  version: 1.0.0
extends: openapi/zoho-crm-attachments-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: 4
- target: $.paths['/{moduleApiName}/{recordId}/Attachments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a record's attachment file
      effect: read
      questions:
      - How do I download the actual file attached to a CRM record?
      - Can link-type attachments be downloaded as files?
      instructions:
      - text: Download attachment {id} from {moduleApiName} record {recordId}.
        slots:
          id: path.id
          moduleApiName: path.moduleApiName
          recordId: path.recordId
      - text: Get the file content of attachment {id} on record {recordId} in {moduleApiName}.
        slots:
          id: path.id
          recordId: path.recordId
          moduleApiName: path.moduleApiName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{moduleApiName}/{recordId}/Attachments/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a link attachment from a record
      effect: destructive
      questions:
      - Can I remove a link attachment from a record?
      - What's the way to delete an attached URL from a deal?
      instructions:
      - text: Delete link attachment {id} from {moduleApiName} record {recordId}.
        slots:
          id: path.id
          moduleApiName: path.moduleApiName
          recordId: path.recordId
      - text: Remove attachment {id} on record {recordId} in {moduleApiName}.
        slots:
          id: path.id
          recordId: path.recordId
          moduleApiName: path.moduleApiName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{moduleApiName}/{recordId}/Attachments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a record's attachments
      effect: read
      questions:
      - What files and links are attached to a particular record?
      - Can I choose which attachment fields come back for a record?
      instructions:
      - text: List the attachments on {moduleApiName} record {recordId}.
        slots:
          moduleApiName: path.moduleApiName
          recordId: path.recordId
      - text: Show {fields} for every attachment on record {recordId} in {moduleApiName}.
        slots:
          fields: query.fields
          recordId: path.recordId
          moduleApiName: path.moduleApiName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{moduleApiName}/{recordId}/Attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a file or URL to a record
      effect: write
      questions:
      - How do I attach a file to a contact or deal in Zoho CRM?
      - Can I attach a link instead of a file, and how large can an upload be?
      instructions:
      - text: Upload an attachment to {moduleApiName} record {recordId}.
        slots:
          moduleApiName: path.moduleApiName
          recordId: path.recordId
      - text: Attach this URL to record {recordId} in {moduleApiName}.
        slots:
          recordId: path.recordId
          moduleApiName: path.moduleApiName
      method: generated
      generated: '2026-09-26'