# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Klaviyo Lists API
  version: 1.0.0
extends: openapi/klaviyo-lists-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: 13
- target: $.paths['/api/lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscriber lists
      effect: read
      questions:
      - What subscriber lists do I have in Klaviyo?
      - Can I find lists by name or creation date?
      - Which lists were updated recently?
      instructions:
      - text: List subscriber lists matching {filter}.
        slots:
          filter: query.filter
      - text: Show all lists sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a subscriber list
      effect: write
      questions:
      - How do I create a new email list?
      - Is there a daily limit on creating lists?
      instructions:
      - text: Create a list {list}.
        slots:
          list: requestBody.data
      - text: 'Make a new subscriber list: {list}.'
        slots:
          list: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lists/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one list
      effect: read
      questions:
      - What are the details of a specific list?
      - Can I get a list's profile count?
      instructions:
      - text: Get list {list_id}.
        slots:
          list_id: path.id
      - text: Show list {list_id} with {extra} included.
        slots:
          list_id: path.id
          extra: query.additional-fields[list]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lists/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a list
      effect: destructive
      questions:
      - Can I delete a subscriber list?
      - What's the way to remove a list I no longer use?
      instructions:
      - text: Delete list {list_id}.
        slots:
          list_id: path.id
      - text: Permanently remove subscriber list {list_id}.
        slots:
          list_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lists/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a list
      effect: write
      questions:
      - How do I rename one of my lists?
      - Can I change a list's name after creating it?
      instructions:
      - text: Rename list {list_id} using {changes}.
        slots:
          list_id: path.id
          changes: requestBody.data
      - text: Change the name of list {list_id} to {changes}.
        slots:
          list_id: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lists/{id}/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List the tags on a list
      effect: read
      questions:
      - What tags are on a particular subscriber list?
      - Can I see tag names for one list?
      instructions:
      - text: List the tags on list {list_id}.
        slots:
          list_id: path.id
      - text: Show tag names applied to list {list_id}.
        slots:
          list_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lists/{id}/relationships/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List tag IDs on a list
      effect: read
      questions:
      - Can I get only the tag IDs for a list?
      - Which tag IDs are attached to one list?
      instructions:
      - text: Get only the tag IDs on list {list_id}.
        slots:
          list_id: path.id
      - text: Return the tag ID list for list {list_id}.
        slots:
          list_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lists/{id}/profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List the profiles in a list
      effect: read
      questions:
      - Who is subscribed to a particular list?
      - Can I find a list member by email or phone number?
      - How do I see who joined a list most recently?
      instructions:
      - text: List the profiles in list {list_id}.
        slots:
          list_id: path.id
      - text: Find members of list {list_id} matching {filter}.
        slots:
          list_id: path.id
          filter: query.filter
      - text: Show profiles in list {list_id} sorted by {sort}.
        slots:
          list_id: path.id
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lists/{id}/relationships/profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List profile IDs in a list
      effect: read
      questions:
      - Can I get only the profile IDs of a list's members?
      - Which profile IDs belong to one list?
      instructions:
      - text: Get only the profile IDs in list {list_id}.
        slots:
          list_id: path.id
      - text: Return member profile IDs for list {list_id}.
        slots:
          list_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lists/{id}/relationships/profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Add profiles to a list
      effect: write
      questions:
      - How do I add existing profiles to a list?
      - How many profiles can I add to a list in one call?
      instructions:
      - text: Add profiles {profiles} to list {list_id}.
        slots:
          list_id: path.id
          profiles: requestBody.data
      - text: 'Put these people into list {list_id}: {profiles}.'
        slots:
          list_id: path.id
          profiles: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lists/{id}/relationships/profiles'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove profiles from a list
      effect: destructive
      questions:
      - Can I take people off a list without unsubscribing them?
      - Does removing someone from a list change their consent status?
      instructions:
      - text: Remove profiles {profiles} from list {list_id}.
        slots:
          list_id: path.id
          profiles: requestBody.data
      - text: 'Take these people off list {list_id}: {profiles}.'
        slots:
          list_id: path.id
          profiles: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lists/{id}/flow-triggers'].get
  update:
    x-apievangelist-phrasing:
      intent: List flows triggered by a list
      effect: read
      questions:
      - Which flows start when someone joins a particular list?
      - Can I see full details of flows that use a list as their trigger?
      instructions:
      - text: List the flows triggered by list {list_id}.
        slots:
          list_id: path.id
      - text: Show which automations fire when people join list {list_id}.
        slots:
          list_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lists/{id}/relationships/flow-triggers'].get
  update:
    x-apievangelist-phrasing:
      intent: List IDs of flows triggered by a list
      effect: read
      questions:
      - Can I get only the IDs of flows that a list triggers?
      - What flow IDs use one list as their trigger?
      instructions:
      - text: Get only the IDs of flows triggered by list {list_id}.
        slots:
          list_id: path.id
      - text: Return trigger flow IDs for list {list_id}.
        slots:
          list_id: path.id
      method: generated
      generated: '2026-09-26'