Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Activities.opportunity Status Changes API

5 actions 5 updates phrasing extends openapi/close-activities-opportunity-status-changes-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 5

$.info
$.paths['/activity/status_change/opportunity/'].get
$.paths['/activity/status_change/opportunity/'].post
$.paths['/activity/status_change/opportunity/{id}/'].get
$.paths['/activity/status_change/opportunity/{id}/'].delete

OpenAPI Overlay

Raw ↑ 
# 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.opportunity Status Changes API
  version: 1.0.0
extends: openapi/close-activities-opportunity-status-changes-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: 4
- target: $.paths['/activity/status_change/opportunity/'].get
  update:
    x-apievangelist-phrasing:
      intent: List opportunity status change history
      effect: read
      questions:
      - When did a deal move between stages?
      - Can I list status changes for one opportunity?
      instructions:
      - text: List status changes for opportunity {opportunity_id}.
        slots:
          opportunity_id: query.opportunity_id
      - text: Show opportunity status changes on lead {lead_id}.
        slots:
          lead_id: query.lead_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/status_change/opportunity/'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a historical opportunity status change
      effect: write
      questions:
      - Can I import past deal stage changes from another system?
      - Does logging an opportunity status change move the deal?
      instructions:
      - text: Log a historical opportunity status change.
      - text: Import a past deal stage change from our old CRM.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/status_change/opportunity/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one opportunity status change
      effect: read
      questions:
      - What stage did a deal move from and to in a specific change?
      - Can I fetch one opportunity status change by id?
      instructions:
      - text: Fetch opportunity status change {id}.
        slots:
          id: path.id
      - text: Show the details of deal stage change {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/status_change/opportunity/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an opportunity status change from the feed
      effect: destructive
      questions:
      - Can I remove an irrelevant deal stage change from the feed?
      - Does deleting an opportunity status change revert the deal?
      instructions:
      - text: Delete opportunity status change {id}.
        slots:
          id: path.id
      - text: Remove deal stage change event {id} from the feed.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'