Zoho CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Locking Information S API

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

$.info
$.paths['/{moduleName}/{recordId}/Locking_Information__s'].get
$.paths['/{moduleName}/{recordId}/Locking_Information__s'].post
$.paths['/{moduleName}/{recordId}/Locking_Information__s/{lockId}'].put
$.paths['/{moduleName}/{recordId}/Locking_Information__s/{lockId}'].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 Locking Information S API
  version: 1.0.0
extends: openapi/zoho-crm-locking-information-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: 4
- target: $.paths['/{moduleName}/{recordId}/Locking_Information__s'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a record's lock details
      effect: read
      questions:
      - Is this record locked, and who locked it and why?
      - Can I see the locking information for a record in any module?
      instructions:
      - text: Show the locking information for {moduleName} record {recordId}.
        slots:
          moduleName: path.moduleName
          recordId: path.recordId
      - text: Get {fields} of the lock on record {recordId} in {moduleName}.
        slots:
          fields: query.fields
          recordId: path.recordId
          moduleName: path.moduleName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{moduleName}/{recordId}/Locking_Information__s'].post
  update:
    x-apievangelist-phrasing:
      intent: Lock a record
      effect: write
      questions:
      - How do I lock a record so others can't edit it?
      - Can I give a reason when locking a deal?
      instructions:
      - text: Lock {moduleName} record {recordId} with {data}.
        slots:
          moduleName: path.moduleName
          recordId: path.recordId
          data: requestBody.data
      - text: Put a lock on record {recordId} in {moduleName}.
        slots:
          recordId: path.recordId
          moduleName: path.moduleName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{moduleName}/{recordId}/Locking_Information__s/{lockId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the reason on a record lock
      effect: write
      questions:
      - Can I change the locking reason on a record that's already locked?
      - What's the way to edit an existing lock's details?
      instructions:
      - text: Update lock {lockId} on {moduleName} record {recordId} with {data}.
        slots:
          lockId: path.lockId
          moduleName: path.moduleName
          recordId: path.recordId
          data: requestBody.data
      - text: Change the reason for lock {lockId} on record {recordId} in {moduleName}.
        slots:
          lockId: path.lockId
          recordId: path.recordId
          moduleName: path.moduleName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{moduleName}/{recordId}/Locking_Information__s/{lockId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlock a locked record
      effect: destructive
      questions:
      - How do I unlock a record so it can be edited again?
      - Can I remove a specific lock from a record?
      instructions:
      - text: Remove lock {lockId} from {moduleName} record {recordId}.
        slots:
          lockId: path.lockId
          moduleName: path.moduleName
          recordId: path.recordId
      - text: Unlock record {recordId} in {moduleName} by removing lock {lockId}.
        slots:
          recordId: path.recordId
          moduleName: path.moduleName
          lockId: path.lockId
      method: generated
      generated: '2026-09-26'