Omnisend · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Brands API

3 actions 3 updates phrasing extends openapi/omnisend-brands-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 3

$.info
$.paths['/brands/current'].get
$.paths['/brands/current'].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 Brands API
  version: 1.0.0
extends: openapi/omnisend-brands-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: 2
- target: $.paths['/brands/current'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current brand's information
      effect: read
      questions:
      - Which store is connected to my Omnisend account?
      - Can I read my brand's details such as its website and currency?
      instructions:
      - text: Show the current brand's information.
      - text: Get my brand details using API version {version}.
        slots:
          version: header.Omnisend-Version
      method: generated
      generated: '2026-10-02'
- target: $.paths['/brands/current'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect a store as a brand
      effect: write
      questions:
      - How do I connect my store's website to the platform through the OAuth flow?
      - What platform, version and website details are needed to connect a brand?
      instructions:
      - text: Connect my site {website} running on platform {platform} version {version}.
        slots:
          website: requestBody.website
          platform: requestBody.platform
          version: requestBody.version
      - text: Connect store {website} on {platform} {version} with currency {currency}.
        slots:
          website: requestBody.website
          platform: requestBody.platform
          version: requestBody.version
          currency: requestBody.currency
      method: generated
      generated: '2026-10-02'