Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Leads API

7 actions 7 updates phrasing extends openapi/close-leads-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 7

$.info

$.paths['/lead/'].get

$.paths['/lead/'].post

$.paths['/lead/merge/'].post

$.paths['/lead/{id}/'].get

$.paths['/lead/{id}/'].put

$.paths['/lead/{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 Leads API
  version: 1.0.0
extends: openapi/close-leads-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: 6
- target: $.paths['/lead/'].get
  update:
    x-apievangelist-phrasing:
      intent: List leads
      effect: read
      questions:
      - How can I pull every lead in my Close account?
      - Can I return only certain fields when listing leads?
      instructions:
      - text: List our leads.
      - text: List {limit} leads showing only {fields}.
        slots:
          limit: query._limit
          fields: query._fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lead/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a lead
      effect: write
      questions:
      - Can I create a lead with its contacts and address in one call?
      - What status does a new lead get if I don't set one?
      instructions:
      - text: Create a lead for Acme Corp with its main contact.
      - text: Add a new lead with custom field values and a Potential status.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lead/merge/'].post
  update:
    x-apievangelist-phrasing:
      intent: Merge two duplicate leads
      effect: destructive
      questions:
      - How do I merge a duplicate lead into another one?
      - Which lead survives when two leads are merged?
      instructions:
      - text: Merge the source lead into the destination lead.
      - text: Combine these two duplicate leads into one.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lead/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single lead
      effect: read
      questions:
      - Where can I see everything about one lead?
      - Can I fetch just a few fields of a specific lead?
      instructions:
      - text: Show lead {id}.
        slots:
          id: path.id
      - text: Get the {fields} of lead {id}.
        slots:
          id: path.id
          fields: query._fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lead/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a lead
      effect: write
      questions:
      - Can I change a lead's status or custom fields without replacing the lead?
      - Why can't I edit a lead's nested contacts here?
      instructions:
      - text: Update lead {id} to the Qualified status.
        slots:
          id: path.id
      - text: Change the name and custom fields on lead {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lead/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a lead
      effect: destructive
      questions:
      - Can I permanently delete a lead from the CRM?
      - What's the call to remove a lead?
      instructions:
      - text: Delete lead {id}.
        slots:
          id: path.id
      - text: Permanently remove lead {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'