Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Smart Views API

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

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

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

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

$.paths['/saved_search/{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 Smart Views API
  version: 1.0.0
extends: openapi/close-smart-views-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['/saved_search/'].get
  update:
    x-apievangelist-phrasing:
      intent: List Smart Views
      effect: read
      questions:
      - What saved Smart Views does our team have?
      - Can I list contact Smart Views instead of lead ones?
      instructions:
      - text: List our Smart Views.
      - text: List Smart Views of type {type}.
        slots:
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/saved_search/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Smart View
      effect: write
      questions:
      - How do I save a lead search as a Smart View?
      - Can I create a Smart View that returns contacts?
      instructions:
      - text: Save a Smart View for leads with no activity in 30 days.
      - text: Create a contact Smart View for decision makers.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/saved_search/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single Smart View
      effect: read
      questions:
      - What query is behind a particular Smart View?
      - How do I look up one Smart View by ID?
      instructions:
      - text: Show Smart View {id}.
        slots:
          id: path.id
      - text: Fetch the search query of Smart View {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/saved_search/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Smart View
      effect: write
      questions:
      - Can I change the filters on a saved Smart View?
      - How do I rename a Smart View?
      instructions:
      - text: Rename Smart View {id}.
        slots:
          id: path.id
      - text: Update the query of Smart View {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/saved_search/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Smart View
      effect: destructive
      questions:
      - Can I delete a Smart View nobody uses?
      - What's the way to remove a saved Smart View?
      instructions:
      - text: Delete Smart View {id}.
        slots:
          id: path.id
      - text: Remove saved Smart View {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'