Encharge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Encharge Email Templates API

10 actions 10 updates phrasing extends openapi/encharge-email-templates-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Encharge's API. It is a proposal applied on top of the contract, not a document Encharge publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info

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

$.paths['/emails/{id}'].delete

$.paths['/emails/{id}'].patch

$.paths['/emails'].post

$.paths['/emails/{id}/versions'].get

$.paths['/emails/{id}/versions/{version}'].get

$.paths['/emails/{id}/versions/selected'].get

$.paths['/emails/{id}/versions/latest'].patch

$.paths['/emails/{id}/versions/{version}/restore'].post

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 Encharge Email Templates API
  version: 1.0.0
extends: openapi/encharge-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: 9
- target: $.paths['/emails/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email template
      effect: read
      questions:
      - How do I fetch an email template's content and settings?
      - What subject and sender does a given email template use?
      instructions:
      - text: Get email template {id}.
        slots:
          id: path.id
      - text: Show me the email template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email template
      effect: destructive
      questions:
      - How do I delete an email template I don't use anymore?
      - Can I permanently remove an email template?
      instructions:
      - text: Delete email template {id}.
        slots:
          id: path.id
      - text: Remove the email template {id} from my account.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Modify an email template
      effect: write
      questions:
      - How do I change the subject line of an existing email template?
      - Can I archive an email template instead of deleting it?
      instructions:
      - text: Change the subject of email template {id} to {subject}.
        slots:
          id: path.id
          subject: requestBody.subject
      - text: Archive email template {id}.
        slots:
          id: path.id
      - text: Set the sender of template {id} to {fromName} <{fromEmail}>.
        slots:
          id: path.id
          fromName: requestBody.fromName
          fromEmail: requestBody.fromEmail
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email template
      effect: write
      questions:
      - How do I create a new email template with HTML content?
      - Can I set a reply-to address and preheader on a new template?
      instructions:
      - text: Create an email template {name} with subject {subject} from {fromEmail}.
        slots:
          name: requestBody.name
          subject: requestBody.subject
          fromEmail: requestBody.fromEmail
      - text: 'Create template {name}, subject {subject}, sent from {fromEmail}, with this HTML: {html}.'
        slots:
          name: requestBody.name
          subject: requestBody.subject
          fromEmail: requestBody.fromEmail
          html: requestBody.html
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails/{id}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List an email template's version history
      effect: read
      questions:
      - How do I see the past versions of an email template?
      - Can I page through an email template's edit history?
      instructions:
      - text: List the version history of email template {id}.
        slots:
          id: path.id
      - text: Show the last {limit} versions of template {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails/{id}/versions/{version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a specific email template version
      effect: read
      questions:
      - How do I view what an email template looked like in an earlier version?
      - Can I fetch one particular version number of a template?
      instructions:
      - text: Get version {version} of email template {id}.
        slots:
          version: path.version
          id: path.id
      - text: Show template {id} as it was at version {version}.
        slots:
          id: path.id
          version: path.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails/{id}/versions/selected'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the currently selected template version
      effect: read
      questions:
      - Which version of an email template is currently selected?
      - How do I check the active version of a template?
      instructions:
      - text: Get the currently selected version of email template {id}.
        slots:
          id: path.id
      - text: Tell me which version of template {id} is active right now.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails/{id}/versions/latest'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update the latest version of a template
      effect: write
      questions:
      - How do I edit the newest version of an email template's HTML?
      - Can I change only the latest draft version of a template?
      instructions:
      - text: 'Update the latest version of template {id} with this HTML: {html}.'
        slots:
          id: path.id
          html: requestBody.html
      - text: Set the preheader on the latest version of template {id} to {preheader}.
        slots:
          id: path.id
          preheader: requestBody.preheader
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails/{id}/versions/{version}/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore an earlier template version
      effect: write
      questions:
      - How do I roll an email template back to an older version?
      - Can I make a previous version the current email content again?
      instructions:
      - text: Restore version {version} of email template {id}.
        slots:
          version: path.version
          id: path.id
      - text: Roll template {id} back to version {version}.
        slots:
          id: path.id
          version: path.version
      method: generated
      generated: '2026-10-01'