Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Backend Email & SMS Templates API

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

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/templates/{template_type}'].get
$.paths['/templates/{template_type}/{slug}'].get
$.paths['/templates/{template_type}/{slug}'].put
$.paths['/templates/{template_type}/{slug}/revert'].post
$.paths['/templates/{template_type}/{slug}/preview'].post
$.paths['/templates/{template_type}/{slug}/toggle_delivery'].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 Clerk Backend Email & SMS Templates API
  version: 1.0.0
extends: openapi/clerk-com-email-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: 6
- target: $.paths['/templates/{template_type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List email or SMS templates
      effect: read
      questions:
      - Which email templates can I customize for my instance?
      - Can I list all SMS templates in order?
      instructions:
      - text: List all {template_type} templates.
        slots:
          template_type: path.template_type
      - text: Show every template of type {template_type} sorted by position.
        slots:
          template_type: path.template_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/templates/{template_type}/{slug}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one email or SMS template
      effect: read
      questions:
      - What does the current verification code email template say?
      - Can I read the subject and body of a specific template?
      instructions:
      - text: Get the {template_type} template {slug}.
        slots:
          template_type: path.template_type
          slug: path.slug
      - text: Show the subject and body of {template_type} template {slug}.
        slots:
          template_type: path.template_type
          slug: path.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/templates/{template_type}/{slug}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an email or SMS template
      effect: write
      questions:
      - How do I customize the subject and body of an email template?
      - Can I change the from name or reply-to name on an email template?
      instructions:
      - text: Set the subject of {template_type} template {slug} to {subject}.
        slots:
          template_type: path.template_type
          slug: path.slug
          subject: requestBody.subject
      - text: Replace the body of {template_type} template {slug} with {body}.
        slots:
          template_type: path.template_type
          slug: path.slug
          body: requestBody.body
      method: generated
      generated: '2026-09-26'
- target: $.paths['/templates/{template_type}/{slug}/revert'].post
  update:
    x-apievangelist-phrasing:
      intent: Revert a template to its default
      effect: destructive
      questions:
      - How do I undo my customizations and restore a template's default?
      - Can a customized template be reset?
      instructions:
      - text: Revert {template_type} template {slug} to default.
        slots:
          template_type: path.template_type
          slug: path.slug
      - text: Reset my changes to template {slug} of type {template_type}.
        slots:
          template_type: path.template_type
          slug: path.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/templates/{template_type}/{slug}/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview changes to a template
      effect: read
      questions:
      - Can I see how a template will render before saving my edits?
      - What would an email look like with a new subject and body?
      instructions:
      - text: Preview {template_type} template {slug} with body {body}.
        slots:
          template_type: path.template_type
          slug: path.slug
          body: requestBody.body
      - text: Render a preview of {template_type} template {slug} with subject {subject}.
        slots:
          template_type: path.template_type
          slug: path.slug
          subject: requestBody.subject
      method: generated
      generated: '2026-09-26'
- target: $.paths['/templates/{template_type}/{slug}/toggle_delivery'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn Clerk delivery on or off for a template
      effect: write
      questions:
      - How do I send a template's emails myself instead of having Clerk deliver them?
      - If I disable delivery for a template, which webhook do I listen to?
      instructions:
      - text: Stop Clerk from delivering {template_type} template {slug}.
        slots:
          template_type: path.template_type
          slug: path.slug
      - text: Set delivery by Clerk to {delivered_by_clerk} for {template_type} template {slug}.
        slots:
          template_type: path.template_type
          slug: path.slug
          delivered_by_clerk: requestBody.delivered_by_clerk
      method: generated
      generated: '2026-09-26'