# 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 Notes API
  version: 1.0.0
extends: openapi/zoho-crm-notes-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: 14
- target: $.paths['/Notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List notes across the CRM
      effect: read
      questions:
      - How do I pull every note in the CRM regardless of which record it's attached to?
      - Can I sort all notes org-wide by a field and page through them?
      instructions:
      - text: List all notes in the Notes module.
      - text: Fetch the notes with IDs {ids} from the Notes module.
        slots:
          ids: query.ids
      - text: List all notes sorted by {sort_by} in {sort_order} order.
        slots:
          sort_by: query.sort_by
          sort_order: query.sort_order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Notes'].put
  update:
    x-apievangelist-phrasing:
      intent: Update multiple notes in bulk
      effect: write
      questions:
      - Can I edit the titles or content of many notes at once without going through their records?
      - What must each note include when bulk-updating notes module-wide?
      instructions:
      - text: 'Bulk update these notes in the Notes module: {data}.'
        slots:
          data: requestBody.data
      - text: 'Change the content of several notes at once: {data}.'
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create notes in the Notes module
      effect: write
      questions:
      - Can I create several notes in one request directly in the Notes module?
      - What's the way to add notes in bulk where each note names its own parent record?
      instructions:
      - text: 'Create these notes in the Notes module: {data}.'
        slots:
          data: requestBody.data
      - text: 'Add a batch of new notes, each linked to its own parent: {data}.'
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Notes'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several notes by ID
      effect: destructive
      questions:
      - How do I permanently delete a batch of notes using a comma-separated list of IDs?
      - Is deleting notes from the Notes module reversible?
      instructions:
      - text: Permanently delete notes {ids}.
        slots:
          ids: query.ids
      - text: Remove the notes with IDs {ids} from the Notes module.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Notes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a note by its ID
      effect: read
      questions:
      - Where can I read one note when I only know the note ID?
      - Can I fetch a single note and limit which fields come back?
      instructions:
      - text: Get note {id}.
        slots:
          id: path.id
      - text: Show only the {fields} fields of note {id}.
        slots:
          fields: query.fields
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Notes/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a note by its ID
      effect: write
      questions:
      - Can I edit a note's title or content knowing only its note ID?
      - Do I need both a title and content to update one note?
      instructions:
      - text: Update note {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Rewrite the content of note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Notes/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a note by its ID
      effect: destructive
      questions:
      - How do I permanently delete one note using just its note ID?
      - Can a single note be removed without knowing which record it's on?
      instructions:
      - text: Delete note {id} permanently.
        slots:
          id: path.id
      - text: Remove note {id} from the Notes module.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{parentRecordModule}/{parentRecordId}/Notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List notes on a specific record
      effect: read
      questions:
      - What notes have been added to a particular deal or contact?
      - Can I page through the notes attached to one record in a chosen sort order?
      instructions:
      - text: List the notes on {parentRecordModule} record {parentRecordId}.
        slots:
          parentRecordModule: path.parentRecordModule
          parentRecordId: path.parentRecordId
      - text: Show notes for {parentRecordModule} record {parentRecordId} sorted by {sort_by}.
        slots:
          parentRecordModule: path.parentRecordModule
          parentRecordId: path.parentRecordId
          sort_by: query.sort_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{parentRecordModule}/{parentRecordId}/Notes'].put
  update:
    x-apievangelist-phrasing:
      intent: Update several notes on one record
      effect: write
      questions:
      - Can I edit multiple notes that all belong to the same record at once?
      - Is there a way to update a record's notes together through that record?
      instructions:
      - text: 'Update these notes on {parentRecordModule} record {parentRecordId}: {data}.'
        slots:
          parentRecordModule: path.parentRecordModule
          parentRecordId: path.parentRecordId
          data: requestBody.data
      - text: Edit all the listed notes under record {parentRecordId} in {parentRecordModule}.
        slots:
          parentRecordId: path.parentRecordId
          parentRecordModule: path.parentRecordModule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{parentRecordModule}/{parentRecordId}/Notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add notes to a specific record
      effect: write
      questions:
      - How do I attach a note to a contact, lead or deal?
      - Can I add more than one note to the same record in a single call?
      instructions:
      - text: 'Add a note to {parentRecordModule} record {parentRecordId}: {data}.'
        slots:
          parentRecordModule: path.parentRecordModule
          parentRecordId: path.parentRecordId
          data: requestBody.data
      - text: Log these notes against record {parentRecordId} in {parentRecordModule}.
        slots:
          parentRecordId: path.parentRecordId
          parentRecordModule: path.parentRecordModule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{parentRecordModule}/{parentRecordId}/Notes'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several notes from one record
      effect: destructive
      questions:
      - Can I remove multiple notes from a single record at once?
      - What's the way to clear specific notes off one deal by their IDs?
      instructions:
      - text: Delete notes {ids} from {parentRecordModule} record {parentRecordId}.
        slots:
          ids: query.ids
          parentRecordModule: path.parentRecordModule
          parentRecordId: path.parentRecordId
      - text: Remove the notes {ids} attached to record {parentRecordId} in {parentRecordModule}.
        slots:
          ids: query.ids
          parentRecordId: path.parentRecordId
          parentRecordModule: path.parentRecordModule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{parentRecordModule}/{parentRecordId}/Notes/{noteId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one note on a specific record
      effect: read
      questions:
      - Where can I read a single note in the context of the record it belongs to?
      - Can I fetch one note by its ID under its parent contact or deal?
      instructions:
      - text: Get note {noteId} on {parentRecordModule} record {parentRecordId}.
        slots:
          noteId: path.noteId
          parentRecordModule: path.parentRecordModule
          parentRecordId: path.parentRecordId
      - text: Show me note {noteId} attached to record {parentRecordId} in {parentRecordModule}.
        slots:
          noteId: path.noteId
          parentRecordId: path.parentRecordId
          parentRecordModule: path.parentRecordModule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{parentRecordModule}/{parentRecordId}/Notes/{noteId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one note on a specific record
      effect: write
      questions:
      - Can I edit a single note under the record it's attached to?
      - What's needed to change one note's title on a particular deal?
      instructions:
      - text: Update note {noteId} on {parentRecordModule} record {parentRecordId} with {data}.
        slots:
          noteId: path.noteId
          parentRecordModule: path.parentRecordModule
          parentRecordId: path.parentRecordId
          data: requestBody.data
      - text: Change the title of note {noteId} under record {parentRecordId} in {parentRecordModule}.
        slots:
          noteId: path.noteId
          parentRecordId: path.parentRecordId
          parentRecordModule: path.parentRecordModule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{parentRecordModule}/{parentRecordId}/Notes/{noteId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one note from a specific record
      effect: destructive
      questions:
      - How do I delete a single note from the record it belongs to?
      - Can I remove one note off a contact using the note ID in the URL?
      instructions:
      - text: Delete note {noteId} from {parentRecordModule} record {parentRecordId}.
        slots:
          noteId: path.noteId
          parentRecordModule: path.parentRecordModule
          parentRecordId: path.parentRecordId
      - text: Remove only note {noteId} from record {parentRecordId} in {parentRecordModule}.
        slots:
          noteId: path.noteId
          parentRecordId: path.parentRecordId
          parentRecordModule: path.parentRecordModule
      method: generated
      generated: '2026-09-26'