SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Templates API

7 actions 7 updates phrasing extends openapi/sendgrid-templates-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for SendGrid's API. It is a proposal applied on top of the contract, not a document SendGrid publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/v3/templates'].get
$.paths['/v3/templates'].post
$.paths['/v3/templates/{template_id}'].get
$.paths['/v3/templates/{template_id}'].post
$.paths['/v3/templates/{template_id}'].delete
$.paths['/v3/templates/{template_id}'].patch

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 Twilio SendGrid Templates API
  version: 1.0.0
extends: openapi/sendgrid-templates-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v3/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List transactional templates
      effect: read
      questions:
      - Which transactional templates do I have?
      - Can I list only my dynamic templates and page through them?
      instructions:
      - text: List {page_size} of my transactional templates.
        slots:
          page_size: query.page_size
      - text: Show {page_size} {generations} templates per page.
        slots:
          page_size: query.page_size
          generations: query.generations
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a transactional template
      effect: write
      questions:
      - Can I create a new dynamic transactional template?
      - What's the difference between a legacy and a dynamic template when I create one?
      instructions:
      - text: Create a transactional template named {name}.
        slots:
          name: requestBody.name
      - text: Create a {generation} template called {name}.
        slots:
          generation: requestBody.generation
          name: requestBody.name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/templates/{template_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transactional template
      effect: read
      questions:
      - Where can I see a single template and its versions?
      - Which version of a transactional template is active?
      instructions:
      - text: Show transactional template {template_id}.
        slots:
          template_id: path.template_id
      - text: Get template {template_id} with its versions.
        slots:
          template_id: path.template_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/templates/{template_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate a transactional template
      effect: write
      questions:
      - Can I copy an existing template to start a new one from it?
      - Is there a way to clone a transactional template under a new name?
      instructions:
      - text: Duplicate template {template_id}.
        slots:
          template_id: path.template_id
      - text: Copy template {template_id} as {name}.
        slots:
          template_id: path.template_id
          name: requestBody.name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/templates/{template_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a transactional template
      effect: destructive
      questions:
      - Can I delete a transactional template I no longer send?
      - Is removing a template permanent?
      instructions:
      - text: Delete transactional template {template_id}.
        slots:
          template_id: path.template_id
      - text: Remove template {template_id}.
        slots:
          template_id: path.template_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/templates/{template_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a transactional template
      effect: write
      questions:
      - Can I change a transactional template's name without touching its content?
      - Why can't I edit the template body through the template itself?
      instructions:
      - text: Rename template {template_id} to {name}.
        slots:
          template_id: path.template_id
          name: requestBody.name
      - text: Change the name of transactional template {template_id} to {name}.
        slots:
          template_id: path.template_id
          name: requestBody.name
      method: generated
      generated: '2026-09-24'