Omnisend · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Email Content Email Templates API

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

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/email-templates'].get
$.paths['/email-templates'].post
$.paths['/email-templates/{id}'].get
$.paths['/email-templates/{id}'].put
$.paths['/email-templates/{id}'].delete
$.paths['/email-templates/{id}/render'].post
$.paths['/email-templates/import'].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 Email Content Email Templates API
  version: 1.0.0
extends: openapi/omnisend-email-templates-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/email-templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List email templates
      effect: read
      questions:
      - Which email templates do I have, sorted by name?
      - Can I search my email templates by part of their name?
      instructions:
      - text: List email templates whose name contains {nameContains}.
        slots:
          nameContains: query.nameContains
      - text: List my email templates sorted by {sort} in {direction} order.
        slots:
          sort: query.sort
          direction: query.direction
      method: generated
      generated: '2026-10-02'
- target: $.paths['/email-templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email template
      effect: write
      questions:
      - How do I create a new email template from content sections?
      - Can I set general settings when I first save an email template?
      instructions:
      - text: Create an email template named {name} with sections {sections}.
        slots:
          name: requestBody.name
          sections: requestBody.sections
      - text: Save a new email template {name} with general settings {generalSettings}.
        slots:
          name: requestBody.name
          generalSettings: requestBody.generalSettings
      method: generated
      generated: '2026-10-02'
- target: $.paths['/email-templates/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one email template
      effect: read
      questions:
      - Can I fetch a single email template's structure by its ID?
      - What sections are inside a specific email template?
      instructions:
      - text: Get email template {id}.
        slots:
          id: path.id
      - text: Show the sections and settings of email template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/email-templates/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an email template
      effect: write
      questions:
      - How do I overwrite an existing email template with new sections?
      - Can I rename an email template I already saved?
      instructions:
      - text: Replace email template {id} with name {name} and sections {sections}.
        slots:
          id: path.id
          name: requestBody.name
          sections: requestBody.sections
      - text: Rename existing email template {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-02'
- target: $.paths['/email-templates/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email template
      effect: destructive
      questions:
      - Can I delete an email template I no longer need?
      - Is there a way to remove an old template from my email library?
      instructions:
      - text: Delete email template {id}.
        slots:
          id: path.id
      - text: Remove the unused email template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/email-templates/{id}/render'].post
  update:
    x-apievangelist-phrasing:
      intent: Render an email template to HTML
      effect: read
      questions:
      - Can I get the full HTML body of a saved email template for preview?
      - What HTML would one of my email templates produce?
      instructions:
      - text: Render email template {id} as HTML.
        slots:
          id: path.id
      - text: Give me the preview HTML for template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/email-templates/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import an email template from HTML
      effect: write
      questions:
      - Can I turn raw HTML into an editable email template?
      - What's the size limit for importing an HTML email template?
      instructions:
      - text: 'Import this HTML as an email template named {name}: {html}'
        slots:
          name: requestBody.name
          html: requestBody.html
      - text: Convert the HTML {html} into a structured template called {name}.
        slots:
          html: requestBody.html
          name: requestBody.name
      method: generated
      generated: '2026-10-02'