Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Email Templates API

7 actions 7 updates phrasing extends openapi/close-email-templates-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 7

$.info

$.paths['/email_template/'].get

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

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

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

$.paths['/email_template/{id}/'].delete

$.paths['/email_template/{id}/render/'].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 Email Templates API
  version: 1.0.0
extends: openapi/close-email-templates-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: 6
- target: $.paths['/email_template/'].get
  update:
    x-apievangelist-phrasing:
      intent: List email templates
      effect: read
      questions:
      - Which email templates do we have?
      - Can I list only shared or archived email templates?
      instructions:
      - text: List all email templates.
      - text: Show email templates where shared is {is_shared}.
        slots:
          is_shared: query.is_shared
      - text: List archived email templates.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/email_template/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email template
      effect: write
      questions:
      - How do I save a reusable email template?
      - Can I create a new email template for my sales outreach?
      instructions:
      - text: Create a new email template.
      - text: Save this follow-up email as a template.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/email_template/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch an email template
      effect: read
      questions:
      - What's the subject and body of a given email template?
      - Can I retrieve one email template by id?
      instructions:
      - text: Fetch email template {id}.
        slots:
          id: path.id
      - text: Show me the content of email template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/email_template/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an email template
      effect: write
      questions:
      - Can I edit an existing email template's wording?
      - Is it possible to change a template's subject after creating it?
      instructions:
      - text: Update email template {id}.
        slots:
          id: path.id
      - text: Edit the body of email template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/email_template/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email template
      effect: destructive
      questions:
      - Can I permanently remove an email template?
      - Which call deletes an email template I no longer need?
      instructions:
      - text: Delete email template {id}.
        slots:
          id: path.id
      - text: Remove email template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/email_template/{id}/render/'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview an email template for a lead
      effect: read
      questions:
      - What would an email template look like filled in for a specific lead and contact?
      - Can I preview a template against the results of a lead search?
      instructions:
      - text: Render email template {id} for lead {lead_id} and contact {contact_id}.
        slots:
          id: path.id
          lead_id: query.lead_id
          contact_id: query.contact_id
      - text: Preview template {id} against leads matching {query}.
        slots:
          id: path.id
          query: query.query
      method: generated
      generated: '2026-09-26'