Omnisend · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Email Content API

4 actions 4 updates phrasing extends openapi/omnisend-email-content-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 4

$.info

$.paths['/email-content/{id}'].get

$.paths['/email-content/{id}'].put

$.paths['/email-content/{id}/render'].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 Email Content API
  version: 1.0.0
extends: openapi/omnisend-email-content-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: 3
- target: $.paths['/email-content/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get email content
      effect: read
      questions:
      - What sections and general settings make up a piece of email content?
      - Can I fetch the structured content of an email by its content ID?
      instructions:
      - text: Get email content {id}.
        slots:
          id: path.id
      - text: Show the sections and general settings of email content {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/email-content/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace email content
      effect: write
      questions:
      - How do I fully replace the sections of an existing email's content?
      - Do I have to send the whole content structure when updating email content?
      instructions:
      - text: Replace email content {id} with sections {sections}.
        slots:
          id: path.id
          sections: requestBody.sections
      - text: Overwrite email content {id} using general settings {generalSettings} and sections {sections}.
        slots:
          id: path.id
          generalSettings: requestBody.generalSettings
          sections: requestBody.sections
      method: generated
      generated: '2026-10-02'
- target: $.paths['/email-content/{id}/render'].post
  update:
    x-apievangelist-phrasing:
      intent: Render email content to HTML
      effect: read
      questions:
      - Can I turn stored email content into HTML to preview it?
      - Is any contact personalization applied when email content is rendered?
      instructions:
      - text: Render email content {id} to HTML.
        slots:
          id: path.id
      - text: Give me the HTML preview of email content {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'