Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Management Email Templates API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/email-templates'].post
$.paths['/email-templates/{templateName}'].get
$.paths['/email-templates/{templateName}'].put
$.paths['/email-templates/{templateName}'].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 Auth0 Management Email Templates API
  version: 1.0.0
extends: openapi/auth0-email-templates-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/email-templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email template
      effect: write
      questions:
      - How do I customize the verification email users receive?
      - What fields are required to create an email template?
      instructions:
      - text: Create the {template} email template from {from} with subject {subject}, body {body}, syntax {syntax}, enabled {enabled}.
        slots:
          template: requestBody.template
          from: requestBody.from
          subject: requestBody.subject
          body: requestBody.body
          syntax: requestBody.syntax
          enabled: requestBody.enabled
      - text: Create a new email template.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/email-templates/{templateName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email template by name
      effect: read
      questions:
      - What does my welcome email template currently say?
      - Can I fetch the reset password email template?
      instructions:
      - text: Show the {templateName} email template.
        slots:
          templateName: path.templateName
      - text: Get subject and body of email template {templateName}.
        slots:
          templateName: path.templateName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/email-templates/{templateName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an email template entirely
      effect: write
      questions:
      - Can I overwrite an entire email template with a new version?
      - Which fields must I send to fully replace an email template?
      instructions:
      - text: Replace the {templateName} template as {template} from {from}, subject {subject}, body {body}, syntax {syntax}, enabled {enabled}.
        slots:
          templateName: path.templateName
          template: requestBody.template
          from: requestBody.from
          subject: requestBody.subject
          body: requestBody.body
          syntax: requestBody.syntax
          enabled: requestBody.enabled
      - text: Fully overwrite email template {templateName}.
        slots:
          templateName: path.templateName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/email-templates/{templateName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit parts of an email template
      effect: write
      questions:
      - Can I change just the subject line of an email template?
      - How do I turn off a single email template without resending its body?
      instructions:
      - text: Change the subject of email template {templateName} to {subject}.
        slots:
          templateName: path.templateName
          subject: requestBody.subject
      - text: Set enabled to {enabled} on email template {templateName}.
        slots:
          enabled: requestBody.enabled
          templateName: path.templateName
      method: generated
      generated: '2026-10-01'