Klaviyo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Klaviyo Tags API

27 actions 27 updates phrasing extends openapi/klaviyo-tags-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 27 · first 16 shown; the file carries all of them

$.info
$.paths['/api/tags'].get
$.paths['/api/tags'].post
$.paths['/api/tags/{id}'].get
$.paths['/api/tags/{id}'].delete
$.paths['/api/tags/{id}'].patch
$.paths['/api/tag-groups'].get
$.paths['/api/tag-groups'].post
$.paths['/api/tag-groups/{id}'].get
$.paths['/api/tag-groups/{id}'].delete
$.paths['/api/tag-groups/{id}'].patch
$.paths['/api/tags/{id}/relationships/flows'].get
$.paths['/api/tags/{id}/relationships/flows'].post
$.paths['/api/tags/{id}/relationships/flows'].delete
$.paths['/api/tags/{id}/relationships/campaigns'].get
$.paths['/api/tags/{id}/relationships/campaigns'].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 Klaviyo Tags API
  version: 1.0.0
extends: openapi/klaviyo-tags-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: 26
- target: $.paths['/api/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List tags in the account
      effect: read
      questions:
      - What tags have we created in Klaviyo?
      - Can I find tags whose name contains a word?
      - Can I sort my tags alphabetically by name?
      instructions:
      - text: List tags matching {filter}.
        slots:
          filter: query.filter
      - text: Show all tags sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a tag
      effect: write
      questions:
      - How do I create a new tag for organizing campaigns and flows?
      - Is there a limit on how many tags an account can have?
      - What tag group does a new tag go into if I don't choose one?
      instructions:
      - text: Create a tag {tag}.
        slots:
          tag: requestBody.data
      - text: 'Add a new tag inside a chosen tag group: {tag}.'
        slots:
          tag: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one tag
      effect: read
      questions:
      - What are the details of a specific tag?
      - Can I see which tag group a tag belongs to when I fetch it?
      instructions:
      - text: Get tag {tag_id}.
        slots:
          tag_id: path.id
      - text: Show tag {tag_id} along with its tag group.
        slots:
          tag_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag
      effect: destructive
      questions:
      - Can I delete a tag I no longer use?
      - What happens to campaigns and flows when a tag is deleted?
      instructions:
      - text: Delete tag {tag_id}.
        slots:
          tag_id: path.id
      - text: Remove tag {tag_id} and all its associations.
        slots:
          tag_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a tag
      effect: write
      questions:
      - Can I rename an existing tag?
      - Is it possible to move a tag into a different tag group?
      instructions:
      - text: Rename tag {tag_id} using {changes}.
        slots:
          tag_id: path.id
          changes: requestBody.data
      - text: Change the name of tag {tag_id} to {changes}.
        slots:
          tag_id: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tag-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List tag groups
      effect: read
      questions:
      - What tag groups exist in my account?
      - Which of my tag groups are exclusive?
      instructions:
      - text: List tag groups matching {filter}.
        slots:
          filter: query.filter
      - text: Show every tag group, including the default one.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tag-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a tag group
      effect: write
      questions:
      - How do I create an exclusive tag group?
      - What's the maximum number of tag groups an account can have?
      instructions:
      - text: Create a tag group {group}.
        slots:
          group: requestBody.data
      - text: 'Add a new exclusive tag group: {group}.'
        slots:
          group: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tag-groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one tag group
      effect: read
      questions:
      - What are the settings of a particular tag group?
      - Can I check whether a tag group is exclusive or the default?
      instructions:
      - text: Get tag group {group_id}.
        slots:
          group_id: path.id
      - text: Show whether tag group {group_id} is exclusive.
        slots:
          group_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tag-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag group and its tags
      effect: destructive
      questions:
      - What happens to the tags inside a tag group when I delete it?
      - Can the default tag group be deleted?
      instructions:
      - text: Delete tag group {group_id}.
        slots:
          group_id: path.id
      - text: Remove tag group {group_id} along with all tags in it.
        slots:
          group_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tag-groups/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a tag group
      effect: write
      questions:
      - Can I rename a tag group?
      - Is it possible to make an existing tag group exclusive later?
      instructions:
      - text: Rename tag group {group_id} using {changes}.
        slots:
          group_id: path.id
          changes: requestBody.data
      - text: 'Give tag group {group_id} a new group name: {changes}.'
        slots:
          group_id: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags/{id}/relationships/flows'].get
  update:
    x-apievangelist-phrasing:
      intent: List flows carrying a tag
      effect: read
      questions:
      - Which flows are tagged with a particular tag?
      - Can I get the flow IDs associated with one tag?
      instructions:
      - text: List the flow IDs tagged with {tag_id}.
        slots:
          tag_id: path.id
      - text: Show which flows carry tag {tag_id}.
        slots:
          tag_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags/{id}/relationships/flows'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a tag to flows
      effect: write
      questions:
      - How do I tag several flows at once?
      - How many tags can a single flow have?
      instructions:
      - text: Apply tag {tag_id} to flows {flows}.
        slots:
          tag_id: path.id
          flows: requestBody.data
      - text: Tag flows {flows} with {tag_id}.
        slots:
          tag_id: path.id
          flows: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags/{id}/relationships/flows'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a tag from flows
      effect: destructive
      questions:
      - Can I untag some flows without deleting the tag?
      - How do I take a tag off several flows?
      instructions:
      - text: Remove tag {tag_id} from flows {flows}.
        slots:
          tag_id: path.id
          flows: requestBody.data
      - text: Untag flows {flows} from {tag_id}.
        slots:
          tag_id: path.id
          flows: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags/{id}/relationships/campaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: List campaigns carrying a tag
      effect: read
      questions:
      - Which campaigns are tagged with a specific tag?
      - Can I get campaign IDs for one tag?
      instructions:
      - text: List the campaign IDs tagged with {tag_id}.
        slots:
          tag_id: path.id
      - text: Show which campaigns carry tag {tag_id}.
        slots:
          tag_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags/{id}/relationships/campaigns'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a tag to campaigns
      effect: write
      questions:
      - How do I tag a batch of campaigns?
      - Is there a cap on how many tags a campaign can hold?
      instructions:
      - text: Apply tag {tag_id} to campaigns {campaigns}.
        slots:
          tag_id: path.id
          campaigns: requestBody.data
      - text: Tag campaigns {campaigns} with {tag_id}.
        slots:
          tag_id: path.id
          campaigns: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags/{id}/relationships/campaigns'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a tag from campaigns
      effect: destructive
      questions:
      - Can I untag campaigns without deleting the tag itself?
      - What's the way to strip a tag off several campaigns?
      instructions:
      - text: Remove tag {tag_id} from campaigns {campaigns}.
        slots:
          tag_id: path.id
          campaigns: requestBody.data
      - text: Untag campaigns {campaigns} from {tag_id}.
        slots:
          tag_id: path.id
          campaigns: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags/{id}/relationships/lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List lists carrying a tag
      effect: read
      questions:
      - Which subscriber lists have a particular tag?
      - Can I get list IDs associated with one tag?
      instructions:
      - text: List the list IDs tagged with {tag_id}.
        slots:
          tag_id: path.id
      - text: Show which lists carry tag {tag_id}.
        slots:
          tag_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags/{id}/relationships/lists'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a tag to lists
      effect: write
      questions:
      - How do I tag several subscriber lists at once?
      - How many tags can one list be associated with?
      instructions:
      - text: Apply tag {tag_id} to lists {lists}.
        slots:
          tag_id: path.id
          lists: requestBody.data
      - text: Tag lists {lists} with {tag_id}.
        slots:
          tag_id: path.id
          lists: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags/{id}/relationships/lists'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a tag from lists
      effect: destructive
      questions:
      - Can I untag some lists but keep the tag?
      - What's the way to take a tag off several lists?
      instructions:
      - text: Remove tag {tag_id} from lists {lists}.
        slots:
          tag_id: path.id
          lists: requestBody.data
      - text: Untag lists {lists} from {tag_id}.
        slots:
          tag_id: path.id
          lists: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags/{id}/relationships/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List segments carrying a tag
      effect: read
      questions:
      - Which segments are tagged with a given tag?
      - Can I get segment IDs for one tag?
      instructions:
      - text: List the segment IDs tagged with {tag_id}.
        slots:
          tag_id: path.id
      - text: Show which segments carry tag {tag_id}.
        slots:
          tag_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags/{id}/relationships/segments'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a tag to segments
      effect: write
      questions:
      - Can I tag several segments in one call?
      - Is there a limit to how many tags a segment can have?
      instructions:
      - text: Apply tag {tag_id} to segments {segments}.
        slots:
          tag_id: path.id
          segments: requestBody.data
      - text: Tag segments {segments} with {tag_id}.
        slots:
          tag_id: path.id
          segments: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags/{id}/relationships/segments'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a tag from segments
      effect: destructive
      questions:
      - Can I untag segments without deleting the tag?
      - What's the way to strip a tag off multiple segments?
      instructions:
      - text: Remove tag {tag_id} from segments {segments}.
        slots:
          tag_id: path.id
          segments: requestBody.data
      - text: Untag segments {segments} from {tag_id}.
        slots:
          tag_id: path.id
          segments: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags/{id}/tag-group'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the tag group a tag belongs to
      effect: read
      questions:
      - Which tag group does a particular tag sit in?
      - Can I see the full tag group details for a tag?
      instructions:
      - text: Get the tag group for tag {tag_id}.
        slots:
          tag_id: path.id
      - text: Show the group details that tag {tag_id} belongs to.
        slots:
          tag_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags/{id}/relationships/tag-group'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the tag group ID for a tag
      effect: read
      questions:
      - Can I get just the tag group ID for one tag?
      - What's the group ID of a given tag?
      instructions:
      - text: Get only the tag group ID for tag {tag_id}.
        slots:
          tag_id: path.id
      - text: Return the group ID that tag {tag_id} is in.
        slots:
          tag_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tag-groups/{id}/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List the tags in a tag group
      effect: read
      questions:
      - What tags are inside a particular tag group?
      - Can I see full tag details for one group?
      instructions:
      - text: List the tags in tag group {group_id}.
        slots:
          group_id: path.id
      - text: Show tag names and details within group {group_id}.
        slots:
          group_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tag-groups/{id}/relationships/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List tag IDs in a tag group
      effect: read
      questions:
      - Can I get only the tag IDs in a tag group?
      - Which tag IDs belong to one group?
      instructions:
      - text: Get only the tag IDs in tag group {group_id}.
        slots:
          group_id: path.id
      - text: Return the tag ID list for group {group_id}.
        slots:
          group_id: path.id
      method: generated
      generated: '2026-09-26'