Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Activities.notes API

6 actions 6 updates phrasing extends openapi/close-activities-notes-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Close's API. It is a proposal applied on top of the contract, not a document Close publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/activity/note/'].get

$.paths['/activity/note/'].post

$.paths['/activity/note/{id}/'].get

$.paths['/activity/note/{id}/'].put

$.paths['/activity/note/{id}/'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Close Activities.notes API
  version: 1.0.0
extends: openapi/close-activities-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: 5
- target: $.paths['/activity/note/'].get
  update:
    x-apievangelist-phrasing:
      intent: List note activities
      effect: read
      questions:
      - What notes have been written on a lead?
      - Can I find notes a colleague added in the last week?
      instructions:
      - text: List notes on lead {lead_id}.
        slots:
          lead_id: query.lead_id
      - text: Show notes written by user {user_id}.
        slots:
          user_id: query.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/note/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to a lead
      effect: write
      questions:
      - How do I add a note with an attachment to a lead?
      - Can a new note be pinned on the lead?
      instructions:
      - text: Add a note {note} to lead {lead_id}.
        slots:
          note: requestBody.note
          lead_id: requestBody.lead_id
      - text: Create a note titled {title} on lead {lead_id}.
        slots:
          title: requestBody.title
          lead_id: requestBody.lead_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/note/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single note
      effect: read
      questions:
      - How can I read one note's full text?
      - Where do I see a note's attachments?
      instructions:
      - text: Show note {id}.
        slots:
          id: path.id
      - text: Fetch the content of note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/note/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit, pin or unpin a note
      effect: write
      questions:
      - Can I pin an existing note to the top of a lead?
      - If I set both note and note_html, which one wins?
      instructions:
      - text: Pin note {id}.
        slots:
          id: path.id
      - text: Change the text of note {id} to {note}.
        slots:
          id: path.id
          note: requestBody.note
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/note/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a note
      effect: destructive
      questions:
      - Can I remove a note from a lead's history?
      - What's the way to delete a note someone wrote?
      instructions:
      - text: Delete note {id}.
        slots:
          id: path.id
      - text: Remove note activity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'