Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Bulk Actions.email API

4 actions 4 updates phrasing extends openapi/close-bulk-actions-email-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/email/'].get

$.paths['/bulk_action/email/'].post

$.paths['/bulk_action/email/{id}/'].get

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 Bulk Actions.email API
  version: 1.0.0
extends: openapi/close-bulk-actions-email-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/email/'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk email jobs
      effect: read
      questions:
      - Which bulk email sends have gone out?
      - Can I list bulk emails that used a specific template?
      instructions:
      - text: List bulk email jobs.
      - text: Show bulk emails sent with template {template_id}.
        slots:
          template_id: query.template_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk_action/email/'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a bulk email to matching leads
      effect: write
      questions:
      - How do I email every lead that matches a search?
      - Can a bulk email go to every contact on a lead, not just the primary one?
      instructions:
      - text: Send a bulk email to all leads in my search using my template.
      - text: Start a bulk email that goes to each contact of the matching leads.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bulk_action/email/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk email job
      effect: read
      questions:
      - Is my bulk email send complete?
      - Can I check the status of one bulk email job?
      instructions:
      - text: Fetch bulk email {id}.
        slots:
          id: path.id
      - text: Check the progress of bulk email job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'