Omnisend · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Email Content Email Universal Layouts API

6 actions 6 updates phrasing extends openapi/omnisend-email-universal-layouts-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 6

$.info
$.paths['/email-universal-layouts'].get
$.paths['/email-universal-layouts'].post
$.paths['/email-universal-layouts/{id}'].get
$.paths['/email-universal-layouts/{id}'].put
$.paths['/email-universal-layouts/{id}'].delete

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 Universal Layouts API
  version: 1.0.0
extends: openapi/omnisend-email-universal-layouts-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: 5
- target: $.paths['/email-universal-layouts'].get
  update:
    x-apievangelist-phrasing:
      intent: List universal layouts
      effect: read
      questions:
      - Which universal email layouts exist in my account?
      - Can I find a universal layout by part of its name?
      instructions:
      - text: List universal layouts whose name contains {nameContains}.
        slots:
          nameContains: query.nameContains
      - text: List the newest {limit} universal layouts.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-02'
- target: $.paths['/email-universal-layouts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a universal layout
      effect: write
      questions:
      - How do I create a reusable universal layout for my emails?
      - Can I give a new universal layout both a name and content when creating it?
      instructions:
      - text: Create a universal layout named {name} with content {content}.
        slots:
          name: requestBody.name
          content: requestBody.content
      - text: Add a new universal layout called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-02'
- target: $.paths['/email-universal-layouts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one universal layout
      effect: read
      questions:
      - What content does a specific universal layout hold?
      - Can I look up a universal layout by its ID?
      instructions:
      - text: Get universal layout {id}.
        slots:
          id: path.id
      - text: Show the content of universal layout {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/email-universal-layouts/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a universal layout
      effect: write
      questions:
      - How do I fully replace an existing universal layout's content?
      - Can I rename a universal layout I already created?
      instructions:
      - text: Replace universal layout {id} with content {content}.
        slots:
          id: path.id
          content: requestBody.content
      - text: Rename universal layout {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-02'
- target: $.paths['/email-universal-layouts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a universal layout
      effect: destructive
      questions:
      - Can I delete a universal layout I don't use anymore?
      - Is there a way to remove an outdated universal layout from my account?
      instructions:
      - text: Delete universal layout {id}.
        slots:
          id: path.id
      - text: Remove the outdated universal layout {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'