Klaviyo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Klaviyo Web Feeds API

6 actions 6 updates phrasing extends openapi/klaviyo-web-feeds-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Klaviyo's API. It is a proposal applied on top of the contract, not a document Klaviyo publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/api/web-feeds'].get

$.paths['/api/web-feeds'].post

$.paths['/api/web-feeds/{id}'].get

$.paths['/api/web-feeds/{id}'].delete

$.paths['/api/web-feeds/{id}'].patch

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 Klaviyo Web Feeds API
  version: 1.0.0
extends: openapi/klaviyo-web-feeds-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: 5
- target: $.paths['/api/web-feeds'].get
  update:
    x-apievangelist-phrasing:
      intent: List web feeds
      effect: read
      questions:
      - What web feeds have I connected for dynamic email content?
      - Can I filter my web feeds by name?
      instructions:
      - text: List all my web feeds.
      - text: Show web feeds matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/web-feeds'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a web feed
      effect: write
      questions:
      - How do I connect an external JSON or XML feed to use in emails?
      - What settings does a new web feed need?
      instructions:
      - text: Create a web feed with {web_feed}.
        slots:
          web_feed: requestBody.data
      - text: Connect the feed URL and name in {web_feed} as a new web feed.
        slots:
          web_feed: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/web-feeds/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one web feed
      effect: read
      questions:
      - Which URL is a particular web feed pulling from?
      - Can I look up one web feed by ID?
      instructions:
      - text: Get web feed {feed_id}.
        slots:
          feed_id: path.id
      - text: Show the source URL and settings of web feed {feed_id}.
        slots:
          feed_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/web-feeds/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a web feed
      effect: destructive
      questions:
      - How do I disconnect a web feed I no longer use?
      - Can I delete a web feed by its ID?
      instructions:
      - text: Delete web feed {feed_id}.
        slots:
          feed_id: path.id
      - text: Remove the unused web feed {feed_id}.
        slots:
          feed_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/web-feeds/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a web feed
      effect: write
      questions:
      - Can I change the URL or refresh settings of an existing web feed?
      - What's the way to rename a web feed?
      instructions:
      - text: Update web feed {feed_id} with {changes}.
        slots:
          feed_id: path.id
          changes: requestBody.data
      - text: 'Point web feed {feed_id} at a new source: {changes}.'
        slots:
          feed_id: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-09-26'