Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Opportunities API

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

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

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

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

$.paths['/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 Opportunities API
  version: 1.0.0
extends: openapi/close-opportunities-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['/opportunity/'].get
  update:
    x-apievangelist-phrasing:
      intent: List or filter opportunities
      effect: read
      questions:
      - Which deals are still open for a given rep?
      - How much pipeline value was won this quarter?
      - Can I find stalled opportunities?
      instructions:
      - text: List opportunities for lead {lead_id}.
        slots:
          lead_id: query.lead_id
      - text: Show opportunities with status type {status_type} owned by user {user_id}.
        slots:
          status_type: query.status_type
          user_id: query.user_id
      - text: List opportunities won since {date_won__gte}.
        slots:
          date_won__gte: query.date_won__gte
      method: generated
      generated: '2026-09-26'
- target: $.paths['/opportunity/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an opportunity
      effect: write
      questions:
      - How do I add a new deal to a lead?
      - Can I set the deal value and confidence when creating an opportunity?
      instructions:
      - text: Create an opportunity worth {value} on lead {lead_id}.
        slots:
          value: requestBody.value
          lead_id: requestBody.lead_id
      - text: Open a {value_period} opportunity of {value} in pipeline {pipeline_id}.
        slots:
          value_period: requestBody.value_period
          value: requestBody.value
          pipeline_id: requestBody.pipeline_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/opportunity/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single opportunity
      effect: read
      questions:
      - Where can I see all details of one deal?
      - How do I check an opportunity's value and status?
      instructions:
      - text: Show opportunity {id}.
        slots:
          id: path.id
      - text: Fetch the value and status of opportunity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/opportunity/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an opportunity
      effect: write
      questions:
      - How do I mark a deal as won?
      - Can I unset a custom field on an opportunity?
      instructions:
      - text: Move opportunity {id} to status {status_id}.
        slots:
          id: path.id
          status_id: requestBody.status_id
      - text: Change the value of opportunity {id} to {value}.
        slots:
          id: path.id
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/opportunity/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an opportunity
      effect: destructive
      questions:
      - Can I delete a deal that was created by mistake?
      - What's the way to remove an opportunity?
      instructions:
      - text: Delete opportunity {id}.
        slots:
          id: path.id
      - text: Permanently remove opportunity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'