SendGrid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio SendGrid Templates Templates Versions API

6 actions 6 updates phrasing extends openapi/sendgrid-templates-versions-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 6

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

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 Templates Versions API
  version: 1.0.0
extends: openapi/sendgrid-templates-versions-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: 5
- target: $.paths['/v3/templates/{template_id}/versions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a version to a transactional template
      effect: write
      questions:
      - How do I create a new version of a transactional template?
      - Can I make a new template version active when I create it?
      instructions:
      - text: Create a version of template {template_id} named {name} with subject {subject}.
        slots:
          template_id: path.template_id
          name: requestBody.name
          subject: requestBody.subject
      - text: Add version {name} to template {template_id}, subject {subject}, HTML {html_content}.
        slots:
          name: requestBody.name
          template_id: path.template_id
          subject: requestBody.subject
          html_content: requestBody.html_content
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/templates/{template_id}/versions/{version_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transactional template version
      effect: read
      questions:
      - What content is in a specific version of my template?
      - Can I look up one template version by its ID?
      instructions:
      - text: Get version {version_id} of template {template_id}.
        slots:
          version_id: path.version_id
          template_id: path.template_id
      - text: Show the HTML and subject of template {template_id} version {version_id}.
        slots:
          template_id: path.template_id
          version_id: path.version_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/templates/{template_id}/versions/{version_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a transactional template version
      effect: destructive
      questions:
      - Can I delete an old version of a transactional template?
      - Which call removes a single template version?
      instructions:
      - text: Delete version {version_id} of template {template_id}.
        slots:
          version_id: path.version_id
          template_id: path.template_id
      - text: Remove template {template_id}'s version {version_id}.
        slots:
          template_id: path.template_id
          version_id: path.version_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/templates/{template_id}/versions/{version_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a transactional template version
      effect: write
      questions:
      - Is it possible to change the subject or HTML of an existing template version?
      - What fields can I edit on a version I already created?
      instructions:
      - text: 'Edit version {version_id} of template {template_id}: name {name}, subject {subject}.'
        slots:
          version_id: path.version_id
          template_id: path.template_id
          name: requestBody.name
          subject: requestBody.subject
      - text: Update the HTML of template {template_id} version {version_id} to {html_content}, keeping name {name} and subject {subject}.
        slots:
          template_id: path.template_id
          version_id: path.version_id
          html_content: requestBody.html_content
          name: requestBody.name
          subject: requestBody.subject
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/templates/{template_id}/versions/{version_id}/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a transactional template version
      effect: write
      questions:
      - How do I make a particular version the active one for a template?
      - Can I switch which template version gets sent?
      instructions:
      - text: Activate version {version_id} of template {template_id}.
        slots:
          version_id: path.version_id
          template_id: path.template_id
      - text: Make {version_id} the live version of template {template_id}.
        slots:
          version_id: path.version_id
          template_id: path.template_id
      method: generated
      generated: '2026-09-24'