Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Bulk Actions.edit API

4 actions 4 updates phrasing extends openapi/close-bulk-actions-edit-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 4

$.info
$.paths['/bulk_action/edit/'].get
$.paths['/bulk_action/edit/'].post
$.paths['/bulk_action/edit/{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 Bulk Actions.edit API
  version: 1.0.0
extends: openapi/close-bulk-actions-edit-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: 3
- target: $.paths['/bulk_action/edit/'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk edit jobs
      effect: read
      questions:
      - What bulk edits have been run on our leads?
      - Can I page through past bulk edit jobs?
      instructions:
      - text: List our bulk edits.
      - text: Show the latest {limit} bulk edit jobs.
        slots:
          limit: query._limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk_action/edit/'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk edit many leads at once
      effect: write
      questions:
      - How do I change the status of every lead in a search?
      - Can I clear a custom field across many leads in one go?
      instructions:
      - text: Set the lead status to Qualified on all leads matching my search.
      - text: Clear the Industry custom field from every lead in this Smart View.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk_action/edit/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk edit job
      effect: read
      questions:
      - Has my bulk edit finished yet?
      - How do I check the progress of one bulk edit?
      instructions:
      - text: Show bulk edit {id}.
        slots:
          id: path.id
      - text: Check the status of bulk edit job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'