Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Contacts API

6 actions 6 updates phrasing extends openapi/close-contacts-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['/contact/'].get
$.paths['/contact/'].post
$.paths['/contact/{id}/'].get
$.paths['/contact/{id}/'].put
$.paths['/contact/{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 Contacts API
  version: 1.0.0
extends: openapi/close-contacts-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['/contact/'].get
  update:
    x-apievangelist-phrasing:
      intent: List contacts
      effect: read
      questions:
      - Who are the contacts on a particular lead?
      - Can I page through all contacts in my organization?
      instructions:
      - text: List contacts on lead {lead_id}.
        slots:
          lead_id: query.lead_id
      - text: Show the first {limit} contacts.
        slots:
          limit: query._limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contact/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contact
      effect: write
      questions:
      - How do I add a new person to an existing lead?
      - What happens if I create a contact without a lead id?
      instructions:
      - text: Add contact {name} to lead {lead_id}.
        slots:
          name: requestBody.name
          lead_id: requestBody.lead_id
      - text: Create a contact named {name} with title {title}.
        slots:
          name: requestBody.name
          title: requestBody.title
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contact/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a contact
      effect: read
      questions:
      - What email and phone numbers do we have for a specific contact?
      - Can I retrieve a single contact by id?
      instructions:
      - text: Fetch contact {id}.
        slots:
          id: path.id
      - text: Show the emails and phones for contact {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contact/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a contact
      effect: write
      questions:
      - Can I change a contact's job title or phone numbers?
      - Is it possible to move a contact to a different lead?
      instructions:
      - text: Change contact {id}'s title to {title}.
        slots:
          id: path.id
          title: requestBody.title
      - text: Move contact {id} to lead {lead_id}.
        slots:
          id: path.id
          lead_id: requestBody.lead_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contact/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contact
      effect: destructive
      questions:
      - Can I delete a contact without deleting the lead?
      - Which call removes a contact?
      instructions:
      - text: Delete contact {id}.
        slots:
          id: path.id
      - text: Remove contact {id} from its lead.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'