Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Bulk Actions.delete API

4 actions 4 updates phrasing extends openapi/close-bulk-actions-delete-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/delete/'].get
$.paths['/bulk_action/delete/'].post
$.paths['/bulk_action/delete/{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.delete API
  version: 1.0.0
extends: openapi/close-bulk-actions-delete-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/delete/'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk delete jobs
      effect: read
      questions:
      - Which bulk deletes have been run?
      - Can I page through past bulk delete jobs?
      instructions:
      - text: List bulk delete jobs.
      - text: Show the last {limit} bulk deletes.
        slots:
          limit: query._limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk_action/delete/'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete leads matching a query
      effect: destructive
      questions:
      - How do I delete many leads at once that match a search?
      - Can I skip the confirmation email when a bulk delete finishes?
      instructions:
      - text: Bulk delete all leads matching my search query.
      - text: Start a bulk delete of these leads without sending the done email.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk_action/delete/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk delete job
      effect: read
      questions:
      - Has my bulk delete finished?
      - Can I check the status of one bulk delete job?
      instructions:
      - text: Fetch bulk delete {id}.
        slots:
          id: path.id
      - text: Check the progress of bulk delete job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'