Close · OpenAPI Overlay 1.0.0

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

5 actions 5 updates phrasing extends openapi/close-activities-lead-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/lead/'].get

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

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

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