Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Activities.creations API

3 actions 3 updates phrasing extends openapi/close-activities-creations-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 3

$.info
$.paths['/activity/created/'].get
$.paths['/activity/created/{id}/'].get

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.creations API
  version: 1.0.0
extends: openapi/close-activities-creations-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: 2
- target: $.paths['/activity/created/'].get
  update:
    x-apievangelist-phrasing:
      intent: List record-created activities
      effect: read
      questions:
      - When was a lead created and by whom?
      - Can I list creation events for leads added last month?
      instructions:
      - text: List created activities for lead {lead_id}.
        slots:
          lead_id: query.lead_id
      - text: Show created activities since {date_created__gte}.
        slots:
          date_created__gte: query.date_created__gte
      method: generated
      generated: '2026-09-26'
- target: $.paths['/activity/created/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a record-created activity
      effect: read
      questions:
      - How do I look up a single creation activity?
      - What's recorded in one created activity?
      instructions:
      - text: Show created activity {id}.
        slots:
          id: path.id
      - text: Fetch creation activity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'