Zoho CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Appointments S API

8 actions 8 updates phrasing extends openapi/zoho-crm-appointments-s-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 8

$.info
$.paths['/Appointments__s'].get
$.paths['/Appointments__s'].put
$.paths['/Appointments__s'].post
$.paths['/Appointments__s'].delete
$.paths['/Appointments__s/{appointmentId}'].get
$.paths['/Appointments__s/{appointmentId}'].put
$.paths['/Appointments__s/{appointmentId}'].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 Appointments S API
  version: 1.0.0
extends: openapi/zoho-crm-appointments-s-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: 7
- target: $.paths['/Appointments__s'].get
  update:
    x-apievangelist-phrasing:
      intent: List appointments
      effect: read
      questions:
      - How do I list all appointment records in Zoho CRM?
      - Can I see every appointment booked in the Appointments module?
      instructions:
      - text: List all appointments.
      - text: Show every record in the Appointments module.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Appointments__s'].put
  update:
    x-apievangelist-phrasing:
      intent: Update several appointments at once
      effect: write
      questions:
      - Can I reschedule or edit multiple appointments in a single request?
      - Is there a bulk update for appointment records?
      instructions:
      - text: 'Bulk update these appointments: {data}.'
        slots:
          data: requestBody.data
      - text: 'Apply changes to several appointment records at once: {data}.'
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Appointments__s'].post
  update:
    x-apievangelist-phrasing:
      intent: Book new appointments
      effect: write
      questions:
      - What's the way to book a new appointment record?
      - Can I create several appointments in one call?
      instructions:
      - text: Create appointments {data}.
        slots:
          data: requestBody.data
      - text: 'Book a new appointment with these details: {data}.'
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Appointments__s'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several appointments
      effect: destructive
      questions:
      - Can I delete multiple appointments by passing a list of IDs?
      - What's the way to remove a batch of appointment records?
      instructions:
      - text: Delete appointments {ids}.
        slots:
          ids: query.ids
      - text: Remove the appointment records with IDs {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Appointments__s/{appointmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one appointment
      effect: read
      questions:
      - Where do I look up the details of a single appointment by its ID?
      - What time and status does a specific appointment have?
      instructions:
      - text: Get appointment {appointmentId}.
        slots:
          appointmentId: path.appointmentId
      - text: Show the details of appointment {appointmentId}.
        slots:
          appointmentId: path.appointmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Appointments__s/{appointmentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a single appointment
      effect: write
      questions:
      - Can I edit just one appointment using its ID?
      - How do I reschedule a particular appointment?
      instructions:
      - text: Update appointment {appointmentId} with {data}.
        slots:
          appointmentId: path.appointmentId
          data: requestBody.data
      - text: Reschedule appointment {appointmentId}.
        slots:
          appointmentId: path.appointmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Appointments__s/{appointmentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single appointment
      effect: destructive
      questions:
      - How do I delete one appointment record?
      - Can a specific appointment be removed by its ID?
      instructions:
      - text: Delete appointment {appointmentId}.
        slots:
          appointmentId: path.appointmentId
      - text: Remove only appointment {appointmentId}.
        slots:
          appointmentId: path.appointmentId
      method: generated
      generated: '2026-09-26'