Zoho CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zoho Crm Org API

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

$.info
$.paths['/org/currencies'].get
$.paths['/org/currencies'].put
$.paths['/org/currencies'].post
$.paths['/org/currencies/{currency}'].get
$.paths['/org/currencies/{currency}'].put
$.paths['/org/currencies/actions/enable'].put
$.paths['/org/currencies/actions/enable'].post
$.paths['/org'].get
$.paths['/org/photo'].get
$.paths['/org/photo'].post
$.paths['/org/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 Zoho Crm Org API
  version: 1.0.0
extends: openapi/zoho-crm-org-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: 11
- target: $.paths['/org/currencies'].get
  update:
    x-apievangelist-phrasing:
      intent: List the organization's currencies
      effect: read
      questions:
      - Which currencies have been added to my Zoho CRM organization?
      - Can I see the exchange rates set for all our currencies?
      instructions:
      - text: List all currencies in our organization.
      - text: Show every added currency with its exchange rate.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/org/currencies'].put
  update:
    x-apievangelist-phrasing:
      intent: Update several non-base currencies
      effect: write
      questions:
      - Can I update exchange rates for several currencies in one go?
      - Is the base currency excluded when bulk-updating currencies?
      instructions:
      - text: 'Update these currencies: {currencies}.'
        slots:
          currencies: requestBody.currencies
      - text: Bulk refresh the exchange rates of our non-base currencies with {currencies}.
        slots:
          currencies: requestBody.currencies
      method: generated
      generated: '2026-09-26'
- target: $.paths['/org/currencies'].post
  update:
    x-apievangelist-phrasing:
      intent: Add new currencies to the organization
      effect: write
      questions:
      - How do I add a new currency like EUR to the organization?
      - Can I add multiple currencies at once?
      instructions:
      - text: Add currencies {currencies} to the organization.
        slots:
          currencies: requestBody.currencies
      - text: Create a new currency entry with {currencies}.
        slots:
          currencies: requestBody.currencies
      method: generated
      generated: '2026-09-26'
- target: $.paths['/org/currencies/{currency}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one currency's details
      effect: read
      questions:
      - Where can I see the settings and rate of one specific currency?
      - What format and exchange rate is configured for a given currency ID?
      instructions:
      - text: Get currency {currency}.
        slots:
          currency: path.currency
      - text: Show the exchange rate for currency ID {currency}.
        slots:
          currency: path.currency
      method: generated
      generated: '2026-09-26'
- target: $.paths['/org/currencies/{currency}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a single currency
      effect: write
      questions:
      - Can I change the exchange rate of just one currency by its ID?
      - Is there a way to edit one currency's formatting without touching the others?
      instructions:
      - text: Update currency {currency} with {currencies}.
        slots:
          currency: path.currency
          currencies: requestBody.currencies
      - text: Change the exchange rate of currency {currency}.
        slots:
          currency: path.currency
      method: generated
      generated: '2026-09-26'
- target: $.paths['/org/currencies/actions/enable'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the base currency
      effect: write
      questions:
      - Can I edit the details of our existing base currency?
      - What can I change about the home currency once multi-currency is on?
      instructions:
      - text: Update the base currency with {base_currency}.
        slots:
          base_currency: requestBody.base_currency
      - text: Change the formatting of our home currency to {base_currency}.
        slots:
          base_currency: requestBody.base_currency
      method: generated
      generated: '2026-09-26'
- target: $.paths['/org/currencies/actions/enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable multi-currency and set base currency
      effect: write
      questions:
      - How do I turn on multi-currency support for the organization?
      - Do I have to choose a base currency when enabling multiple currencies?
      instructions:
      - text: Enable multi-currency with {base_currency} as the base currency.
        slots:
          base_currency: requestBody.base_currency
      - text: Turn on multiple currencies for our org and set the base currency.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/org'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the organization's company details
      effect: read
      questions:
      - What company details does the CRM hold for my organization?
      - Can I retrieve the company profile of the CRM account I am signed into?
      instructions:
      - text: Show my organization's company details.
      - text: Get the org profile for our CRM account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/org/photo'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the organization's logo
      effect: read
      questions:
      - Can I download the logo image set for our organization?
      - Is there an org photo currently configured?
      instructions:
      - text: Download our organization's photo.
      - text: Fetch the current company logo image.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/org/photo'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an organization logo
      effect: write
      questions:
      - How do I set a new logo for our organization?
      - Can I replace the company photo with an image file?
      instructions:
      - text: Upload {file} as the organization photo.
        slots:
          file: requestBody.file
      - text: Set our company logo to the image {file}.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/org/photo'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the organization's logo
      effect: destructive
      questions:
      - Can I delete the organization photo altogether?
      - What happens when I remove our company logo?
      instructions:
      - text: Delete the organization photo.
      - text: Remove our company logo image.
      method: generated
      generated: '2026-09-26'