Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Opportunity Statuses API

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

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

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

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

$.paths['/status/opportunity/{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 Opportunity Statuses API
  version: 1.0.0
extends: openapi/close-opportunity-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/opportunity/'].get
  update:
    x-apievangelist-phrasing:
      intent: List opportunity statuses
      effect: read
      questions:
      - What deal stages are defined for opportunities?
      - Can I see all opportunity statuses across pipelines?
      instructions:
      - text: List all opportunity statuses.
      - text: Show the deal stages my opportunities can have.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/status/opportunity/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an opportunity status
      effect: write
      questions:
      - How do I add a new deal stage to a pipeline?
      - Must a new opportunity status be active, won or lost?
      instructions:
      - text: Create a won-type opportunity status in my sales pipeline.
      - text: Add a new active deal stage called Proposal Sent.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/status/opportunity/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch an opportunity status
      effect: read
      questions:
      - Which pipeline does a specific opportunity status belong to?
      - Can I retrieve one opportunity status by id?
      instructions:
      - text: Fetch opportunity status {id}.
        slots:
          id: path.id
      - text: Show the type and pipeline of opportunity status {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/status/opportunity/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename an opportunity status
      effect: write
      questions:
      - Can I rename a deal stage?
      - Is it possible to edit an opportunity status label?
      instructions:
      - text: Rename opportunity status {id}.
        slots:
          id: path.id
      - text: Change the label on deal stage {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/status/opportunity/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an opportunity status
      effect: destructive
      questions:
      - Can I delete a deal stage that opportunities still use?
      - Which call removes an opportunity status?
      instructions:
      - text: Delete opportunity status {id}.
        slots:
          id: path.id
      - text: Remove the unused deal stage {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'