Zoho CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Record Photo API

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

$.info
$.paths['/{module}/{record}/photo'].get
$.paths['/{module}/{record}/photo'].post
$.paths['/{module}/{record}/photo'].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 Record Photo API
  version: 1.0.0
extends: openapi/zoho-crm-photo-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: 3
- target: $.paths['/{module}/{record}/photo'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a record's photo
      effect: read
      questions:
      - How do I download the profile photo on a contact?
      - Can I retrieve the image attached to a lead's record?
      instructions:
      - text: Get the photo for {module} record {record}.
        slots:
          module: path.module
          record: path.record
      - text: Download the profile image of record {record} in {module}.
        slots:
          module: path.module
          record: path.record
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{module}/{record}/photo'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a record's photo
      effect: write
      questions:
      - How do I set a profile picture on a contact?
      - Can I replace a lead's photo with a new image file?
      instructions:
      - text: Upload {file} as the photo for {module} record {record}.
        slots:
          module: path.module
          record: path.record
          file: requestBody.file
      - text: Set a new profile image on record {record} in {module}.
        slots:
          module: path.module
          record: path.record
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{module}/{record}/photo'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a record's photo
      effect: destructive
      questions:
      - How do I remove a contact's profile photo?
      - Can I clear the image from a lead record?
      instructions:
      - text: Delete the photo from {module} record {record}.
        slots:
          module: path.module
          record: path.record
      - text: Remove the profile image on record {record} in {module}.
        slots:
          module: path.module
          record: path.record
      method: generated
      generated: '2026-09-26'