Klaviyo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Klaviyo Tracking Settings API

4 actions 4 updates phrasing extends openapi/klaviyo-tracking-settings-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 4

$.info

$.paths['/api/tracking-settings'].get

$.paths['/api/tracking-settings/{id}'].get

$.paths['/api/tracking-settings/{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 Tracking Settings API
  version: 1.0.0
extends: openapi/klaviyo-tracking-settings-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['/api/tracking-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List UTM tracking settings
      effect: read
      questions:
      - What UTM tracking settings does my account use?
      - Is UTM tracking turned on for my emails?
      instructions:
      - text: List my UTM tracking settings, {page_size} per page.
        slots:
          page_size: query.page[size]
      - text: Show the account's UTM tracking configuration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tracking-settings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the UTM tracking setting for an account
      effect: read
      questions:
      - Can I fetch the UTM tracking setting by account ID?
      - What UTM parameters are added to links for a specific account?
      instructions:
      - text: Get UTM tracking setting {account_id}.
        slots:
          account_id: path.id
      - text: Show the UTM parameters configured for account {account_id}.
        slots:
          account_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tracking-settings/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update UTM tracking settings
      effect: write
      questions:
      - How do I change the UTM parameters added to campaign links?
      - Can I turn automatic UTM tracking on or off?
      instructions:
      - text: Update UTM tracking setting {account_id} with {changes}.
        slots:
          account_id: path.id
          changes: requestBody.data
      - text: Change the UTM link parameters for account {account_id} to {changes}.
        slots:
          account_id: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-09-26'