# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Event Metadata API
  version: 1.0.0
extends: openapi/omnisend-event-metadata-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/event-metadata'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing custom event's schema
      effect: write
      questions:
      - How do I add new properties to a custom event I already defined in Omnisend?
      - Will updating a custom event's metadata remove properties I leave out of the request?
      - Can I change the type of a property that's already explicitly defined on my custom event?
      instructions:
      - text: Rename the display label of my existing custom event {name} from origin {origin} to {displayName}.
        slots:
          name: requestBody.name
          origin: requestBody.origin
          displayName: requestBody.displayName
      - text: Merge the properties {properties} into the existing custom event {name} with origin {origin}.
        slots:
          properties: requestBody.properties
          name: requestBody.name
          origin: requestBody.origin
      method: generated
      generated: '2026-09-26'
- target: $.paths['/event-metadata'].post
  update:
    x-apievangelist-phrasing:
      intent: Declare a new custom event schema
      effect: write
      questions:
      - How can I register a brand-new custom event type so segments and automations can use it?
      - What's required when defining a new custom event schema — display name, properties, origin?
      - Is a custom event identified by its name alone or by name plus origin when I first create it?
      instructions:
      - text: Create a new custom event {name} from origin {origin} labelled {displayName} with properties {properties}.
        slots:
          name: requestBody.name
          origin: requestBody.origin
          displayName: requestBody.displayName
          properties: requestBody.properties
      - text: Declare a new custom event schema called {displayName} for event name {name} coming from {origin}, with properties {properties}.
        slots:
          displayName: requestBody.displayName
          name: requestBody.name
          origin: requestBody.origin
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/event-metadata/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up event metadata by category
      effect: read
      questions:
      - Which events are available to build segments on in Omnisend?
      - Can I list only the built-in automation events and leave out our custom ones?
      - What properties does a given event expose, and can I filter the lookup by origin?
      instructions:
      - text: Show me the event metadata available for the {category} category.
        slots:
          category: requestBody.category
      - text: Look up the {category} metadata for events {events}, including their property trees.
        slots:
          category: requestBody.category
          events: requestBody.events
      - text: List {category} events from origins {origins}, excluding brand-custom events.
        slots:
          category: requestBody.category
          origins: requestBody.origins
      method: generated
      generated: '2026-09-26'