Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Lead Statuses API

6 actions 6 updates phrasing extends openapi/close-lead-statuses-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['/status/lead/'].get

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

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

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

$.paths['/status/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 Lead Statuses API
  version: 1.0.0
extends: openapi/close-lead-statuses-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['/status/lead/'].get
  update:
    x-apievangelist-phrasing:
      intent: List lead statuses
      effect: read
      questions:
      - What lead statuses are set up in my organization?
      - Can I see all the stages a lead can be in?
      instructions:
      - text: List all lead statuses.
      - text: Show my organization's lead status options.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/status/lead/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a lead status
      effect: write
      questions:
      - How do I add a new lead status like 'Nurturing'?
      - Can I create a custom status for leads?
      instructions:
      - text: Create a new lead status called Nurturing.
      - text: Add a lead status option for disqualified leads.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/status/lead/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a lead status
      effect: read
      questions:
      - What's the label and color of a specific lead status?
      - Can I retrieve one lead status by id?
      instructions:
      - text: Fetch lead status {id}.
        slots:
          id: path.id
      - text: Show the details of lead status {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/status/lead/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or recolor a lead status
      effect: write
      questions:
      - Can I rename a lead status or change its color?
      - Does renaming a status change which leads have it?
      instructions:
      - text: Rename lead status {id}.
        slots:
          id: path.id
      - text: Change the color of lead status {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/status/lead/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a lead status
      effect: destructive
      questions:
      - Can I delete a lead status that leads are still using?
      - Which call removes a lead status option?
      instructions:
      - text: Delete lead status {id}.
        slots:
          id: path.id
      - text: Remove the unused lead status {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'