Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Sms Templates API

6 actions 6 updates phrasing extends openapi/close-sms-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 6

$.info

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

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

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

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

$.paths['/sms_template/{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 Sms Templates API
  version: 1.0.0
extends: openapi/close-sms-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: 5
- target: $.paths['/sms_template/'].get
  update:
    x-apievangelist-phrasing:
      intent: List SMS templates
      effect: read
      questions:
      - Which text message templates do we have?
      - Can I page through all SMS templates?
      instructions:
      - text: List all SMS templates.
      - text: Show {limit} SMS templates.
        slots:
          limit: query._limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sms_template/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an SMS template
      effect: write
      questions:
      - How do I save a reusable text message template?
      - Can I share an SMS template with my team when creating it?
      instructions:
      - text: Create an SMS template named {name} with text {text}.
        slots:
          name: requestBody.name
          text: requestBody.text
      - text: Save a shared SMS template called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sms_template/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch an SMS template
      effect: read
      questions:
      - What does a specific SMS template say?
      - Can I get an SMS template along with its attachments?
      instructions:
      - text: Fetch SMS template {id}.
        slots:
          id: path.id
      - text: Show SMS template {id} including attachments.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sms_template/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an SMS template
      effect: write
      questions:
      - Can I change the wording of a text template?
      - Is it possible to archive or unshare an SMS template?
      instructions:
      - text: Change the text of SMS template {id} to {text}.
        slots:
          id: path.id
          text: requestBody.text
      - text: Rename SMS template {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sms_template/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an SMS template
      effect: destructive
      questions:
      - Can I delete a text template we don't use anymore?
      - Which call removes an SMS template?
      instructions:
      - text: Delete SMS template {id}.
        slots:
          id: path.id
      - text: Remove SMS template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'