# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mailchimp Marketing Lists API
  version: 1.0.0
extends: openapi/mailchimp-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: 70
- target: $.paths['/lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List all audiences in the account
      effect: read
      questions:
      - Which audiences do I have in my Mailchimp account?
      - Can I find which of my lists a particular email address belongs to?
      - What lists were created after a certain date, and which have an ecommerce store attached?
      instructions:
      - text: List all my audiences, sorted by creation date.
      - text: Show me every list that contains the subscriber {email}.
        slots:
          email: query.email
      - text: List audiences created since {since_date_created}.
        slots:
          since_date_created: query.since_date_created
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new audience
      effect: write
      questions:
      - How do I create a brand new audience list?
      - What details are required to set up a new mailing list, like contact address and permission reminder?
      instructions:
      - text: Create a new audience called {name} with permission reminder {permission_reminder}.
        slots:
          name: requestBody.name
          permission_reminder: requestBody.permission_reminder
      - text: Set up a new list named {name} using contact address {contact} and campaign defaults {campaign_defaults}.
        slots:
          name: requestBody.name
          contact: requestBody.contact
          campaign_defaults: requestBody.campaign_defaults
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details and stats for one audience
      effect: read
      questions:
      - How many contacts and what settings does one specific audience have?
      - Can I look up the stats and campaign defaults for a single list?
      instructions:
      - text: Show me the details and stats for audience {list_id}.
        slots:
          list_id: path.list_id
      - text: Get the settings, contact info and total contact count of list {list_id}.
        slots:
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Batch subscribe or unsubscribe many contacts
      effect: write
      questions:
      - Can I subscribe or unsubscribe hundreds of contacts to a list in one call?
      - What happens to existing subscribers when I bulk import members and ask to update them?
      instructions:
      - text: 'Bulk subscribe these members to audience {list_id} in one batch: {members}.'
        slots:
          list_id: path.list_id
          members: requestBody.members
      - text: Batch import {members} into list {list_id}, updating anyone who already exists.
        slots:
          members: requestBody.members
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an entire audience
      effect: destructive
      questions:
      - What do I lose if I delete a whole audience, including its subscriber history?
      - Is it possible to permanently remove a list from my account?
      instructions:
      - text: Delete the entire audience {list_id} from my account.
        slots:
          list_id: path.list_id
      - text: Remove list {list_id} permanently, history and all.
        slots:
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an audience's settings
      effect: write
      questions:
      - How do I rename an audience or change its permission reminder text?
      - Can I change the default from name and subject line for an existing list?
      instructions:
      - text: Rename audience {list_id} to {name}.
        slots:
          list_id: path.list_id
          name: requestBody.name
      - text: Update the campaign defaults on list {list_id} to {campaign_defaults}.
        slots:
          list_id: path.list_id
          campaign_defaults: requestBody.campaign_defaults
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/abuse-reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List abuse complaints for an audience
      effect: read
      questions:
      - Have any subscribers marked my emails as spam on this list?
      - Where can I see all the abuse complaints filed against one audience?
      instructions:
      - text: List all abuse reports for audience {list_id}.
        slots:
          list_id: path.list_id
      - text: Show the latest {count} spam complaints on list {list_id}.
        slots:
          count: query.count
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/abuse-reports/{report_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one abuse report
      effect: read
      questions:
      - What are the details of a single spam complaint, such as who filed it and on which campaign?
      - Which campaign triggered a given abuse report on my audience?
      instructions:
      - text: Get abuse report {report_id} on audience {list_id}.
        slots:
          report_id: path.report_id
          list_id: path.list_id
      - text: Show me the details of complaint {report_id} from list {list_id}.
        slots:
          report_id: path.report_id
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/activity'].get
  update:
    x-apievangelist-phrasing:
      intent: Get daily activity stats for an audience
      effect: read
      questions:
      - How many opens, clicks and new subscribers did my list get each day recently?
      - How far back does the daily activity history for an audience go?
      instructions:
      - text: Show daily activity stats for audience {list_id} over the last 180 days.
        slots:
          list_id: path.list_id
      - text: Get the last {count} days of sends, opens and subscribes for list {list_id}.
        slots:
          count: query.count
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/clients'].get
  update:
    x-apievangelist-phrasing:
      intent: See top email clients used by an audience
      effect: read
      questions:
      - Which email apps do my subscribers use most to read my emails?
      - Do most of my list read on Gmail, Outlook or Apple Mail?
      instructions:
      - text: Show the top email clients used by subscribers of audience {list_id}.
        slots:
          list_id: path.list_id
      - text: Which email clients open list {list_id} the most.
        slots:
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/growth-history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get monthly growth history for an audience
      effect: read
      questions:
      - How has my list grown month over month?
      - Can I see monthly subscribes versus unsubscribes for an audience across its lifetime?
      instructions:
      - text: Show the month-by-month growth history of audience {list_id}.
        slots:
          list_id: path.list_id
      - text: List the last {count} months of growth for list {list_id}, newest first.
        slots:
          count: query.count
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/growth-history/{month}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an audience's growth for one month
      effect: read
      questions:
      - How many people joined or left my list in one particular month?
      - Can I see the subscribe and unsubscribe counts for a single month of my list's history?
      instructions:
      - text: Get the growth summary for audience {list_id} in month {month}.
        slots:
          list_id: path.list_id
          month: path.month
      - text: How did list {list_id} grow during {month}.
        slots:
          list_id: path.list_id
          month: path.month
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/interest-categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List interest categories on an audience
      effect: read
      questions:
      - What interest group categories are set up on my list?
      - Can I filter an audience's interest categories by type, like checkboxes or dropdowns?
      instructions:
      - text: List all interest categories on audience {list_id}.
        slots:
          list_id: path.list_id
      - text: Show only the {type} interest categories on list {list_id}.
        slots:
          type: query.type
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/interest-categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an interest category
      effect: write
      questions:
      - How do I add a new group category so subscribers can pick their interests?
      - Can a new interest category be shown as radio buttons or a dropdown on the signup form?
      instructions:
      - text: Create an interest category called {title} on audience {list_id} as {type}.
        slots:
          title: requestBody.title
          list_id: path.list_id
          type: requestBody.type
      - text: Add a checkbox group category named {title} to list {list_id}.
        slots:
          title: requestBody.title
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/interest-categories/{interest_category_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one interest category
      effect: read
      questions:
      - What type and display order does a specific interest category have?
      - Can I fetch a single interest group category by its ID?
      instructions:
      - text: Get interest category {interest_category_id} on audience {list_id}.
        slots:
          interest_category_id: path.interest_category_id
          list_id: path.list_id
      - text: Show the settings of group category {interest_category_id} in list {list_id}.
        slots:
          interest_category_id: path.interest_category_id
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/interest-categories/{interest_category_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an interest category
      effect: destructive
      questions:
      - Can I remove a whole interest group category from my audience?
      - What happens to the interests inside a category when I delete the category?
      instructions:
      - text: Delete interest category {interest_category_id} from audience {list_id}.
        slots:
          interest_category_id: path.interest_category_id
          list_id: path.list_id
      - text: Remove the group category {interest_category_id} from list {list_id}.
        slots:
          interest_category_id: path.interest_category_id
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/interest-categories/{interest_category_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an interest category
      effect: write
      questions:
      - How do I rename an existing interest category or change how it displays?
      - Can I change the display order of an interest category that already exists?
      instructions:
      - text: Rename interest category {interest_category_id} on audience {list_id} to {title}.
        slots:
          interest_category_id: path.interest_category_id
          list_id: path.list_id
          title: requestBody.title
      - text: Change existing category {interest_category_id} in list {list_id} to display as {type}.
        slots:
          interest_category_id: path.interest_category_id
          list_id: path.list_id
          type: requestBody.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/interest-categories/{interest_category_id}/interests'].get
  update:
    x-apievangelist-phrasing:
      intent: List the interests inside a category
      effect: read
      questions:
      - Which group names are inside one interest category?
      - How many subscribers have chosen each interest in a category?
      instructions:
      - text: List the interests in category {interest_category_id} of audience {list_id}.
        slots:
          interest_category_id: path.interest_category_id
          list_id: path.list_id
      - text: Show the group names under interest category {interest_category_id} in list {list_id} with subscriber counts.
        slots:
          interest_category_id: path.interest_category_id
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/interest-categories/{interest_category_id}/interests'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an interest to a category
      effect: write
      questions:
      - Can I add a new group name option under an existing interest category?
      - How do I create a new interest checkbox that subscribers can select?
      instructions:
      - text: Add the interest {name} to category {interest_category_id} on audience {list_id}.
        slots:
          name: requestBody.name
          interest_category_id: path.interest_category_id
          list_id: path.list_id
      - text: Create a new group option {name} in interest category {interest_category_id} of list {list_id}.
        slots:
          name: requestBody.name
          interest_category_id: path.interest_category_id
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one interest in a category
      effect: read
      questions:
      - How many subscribers have picked one specific interest option?
      - Can I look up a single group name by its interest ID?
      instructions:
      - text: Get interest {interest_id} in category {interest_category_id} on audience {list_id}.
        slots:
          interest_id: path.interest_id
          interest_category_id: path.interest_category_id
          list_id: path.list_id
      - text: Show the subscriber count for interest option {interest_id} under category {interest_category_id} in list {list_id}.
        slots:
          interest_id: path.interest_id
          interest_category_id: path.interest_category_id
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an interest from a category
      effect: destructive
      questions:
      - Can I remove a single group name option without deleting its whole category?
      - How do I delete one interest option subscribers can no longer choose?
      instructions:
      - text: Delete interest {interest_id} from category {interest_category_id} on audience {list_id}.
        slots:
          interest_id: path.interest_id
          interest_category_id: path.interest_category_id
          list_id: path.list_id
      - text: Remove the group option {interest_id} under category {interest_category_id} from list {list_id}.
        slots:
          interest_id: path.interest_id
          interest_category_id: path.interest_category_id
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or reorder an interest
      effect: write
      questions:
      - How can I rename one group option or change where it appears in its category?
      - Is it possible to rename an existing interest group name?
      instructions:
      - text: Rename interest {interest_id} in category {interest_category_id} of audience {list_id} to {name}.
        slots:
          interest_id: path.interest_id
          interest_category_id: path.interest_category_id
          list_id: path.list_id
          name: requestBody.name
      - text: Move interest {interest_id} in category {interest_category_id} of list {list_id} to display position {display_order}.
        slots:
          interest_id: path.interest_id
          interest_category_id: path.interest_category_id
          list_id: path.list_id
          display_order: requestBody.display_order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List segments and tags on an audience
      effect: read
      questions:
      - What segments and saved tags exist on my audience?
      - Can I list only static segments, or only those created after a certain date?
      instructions:
      - text: List all segments on audience {list_id}.
        slots:
          list_id: path.list_id
      - text: Show the {type} segments on list {list_id} created since {since_created_at}.
        slots:
          type: query.type
          list_id: path.list_id
          since_created_at: query.since_created_at
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/segments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a segment on an audience
      effect: write
      questions:
      - How do I create a saved segment based on conditions?
      - Can I build a static segment from a set of email addresses when I create it?
      instructions:
      - text: Create a segment called {name} on audience {list_id} with conditions {options}.
        slots:
          name: requestBody.name
          list_id: path.list_id
          options: requestBody.options
      - text: Make a new static segment {name} in list {list_id} containing {static_segment}.
        slots:
          name: requestBody.name
          list_id: path.list_id
          static_segment: requestBody.static_segment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/segments/{segment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one segment's details
      effect: read
      questions:
      - What conditions and member count does a particular segment have?
      - Can I retrieve one segment by ID, with or without cleaned contacts counted?
      instructions:
      - text: Get segment {segment_id} on audience {list_id}.
        slots:
          segment_id: path.segment_id
          list_id: path.list_id
      - text: Show the conditions and size of segment {segment_id} in list {list_id}.
        slots:
          segment_id: path.segment_id
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/segments/{segment_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Batch add or remove members of a static segment
      effect: write
      questions:
      - Can I add and remove many emails from a static segment in a single call?
      - How do I sync a static segment's membership in bulk from my own system?
      instructions:
      - text: Sync static segment {segment_id} on audience {list_id} by adding the list {members_to_add} in one batch.
        slots:
          members_to_add: requestBody.members_to_add
          segment_id: path.segment_id
          list_id: path.list_id
      - text: Batch remove {members_to_remove} from segment {segment_id} in list {list_id}.
        slots:
          members_to_remove: requestBody.members_to_remove
          segment_id: path.segment_id
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/segments/{segment_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a segment
      effect: destructive
      questions:
      - Is there a way to delete a saved segment I no longer use?
      - Does deleting a segment remove the contacts in it from my audience?
      instructions:
      - text: Delete segment {segment_id} from audience {list_id}.
        slots:
          segment_id: path.segment_id
          list_id: path.list_id
      - text: Remove the saved segment {segment_id} on list {list_id}.
        slots:
          segment_id: path.segment_id
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/segments/{segment_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a segment
      effect: write
      questions:
      - How do I rename a segment or change its matching conditions?
      - Can I edit a saved segment after it has been created?
      instructions:
      - text: Rename segment {segment_id} on audience {list_id} to {name}.
        slots:
          segment_id: path.segment_id
          list_id: path.list_id
          name: requestBody.name
      - text: Change the conditions of existing segment {segment_id} in list {list_id} to {options}.
        slots:
          segment_id: path.segment_id
          list_id: path.list_id
          options: requestBody.options
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/segments/{segment_id}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List the members in a segment
      effect: read
      questions:
      - Who are the contacts in one of my saved segments?
      - Can I include unsubscribed or cleaned contacts when listing a segment's members?
      instructions:
      - text: List the members of segment {segment_id} in audience {list_id}.
        slots:
          segment_id: path.segment_id
          list_id: path.list_id
      - text: Show everyone in segment {segment_id} of list {list_id}, including unsubscribed contacts.
        slots:
          segment_id: path.segment_id
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/segments/{segment_id}/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Add one member to a static segment
      effect: write
      questions:
      - How do I put a single subscriber into a static segment?
      - Can I add one email address to a static segment or tag?
      instructions:
      - text: Add {email_address} to static segment {segment_id} on audience {list_id}.
        slots:
          email_address: requestBody.email_address
          segment_id: path.segment_id
          list_id: path.list_id
      - text: Put {email_address} into segment {segment_id} of list {list_id}.
        slots:
          email_address: requestBody.email_address
          segment_id: path.segment_id
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/segments/{segment_id}/members/{subscriber_hash}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one member from a static segment
      effect: destructive
      questions:
      - Can I take a single contact out of a static segment without unsubscribing them?
      - How do I pull a single member out of a static segment?
      instructions:
      - text: Remove subscriber {subscriber_hash} from segment {segment_id} on audience {list_id}.
        slots:
          subscriber_hash: path.subscriber_hash
          segment_id: path.segment_id
          list_id: path.list_id
      - text: Take contact {subscriber_hash} out of static segment {segment_id} in list {list_id}.
        slots:
          subscriber_hash: path.subscriber_hash
          segment_id: path.segment_id
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/tag-search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search an audience's tags by name
      effect: read
      questions:
      - Which tags on my audience have a name containing a certain word?
      - What tags exist on a list at all?
      instructions:
      - text: Search tags on audience {list_id} matching {name}.
        slots:
          list_id: path.list_id
          name: query.name
      - text: Find every tag name used on list {list_id}.
        slots:
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List the members of an audience
      effect: read
      questions:
      - Who is subscribed to my list right now?
      - Can I pull only unsubscribed or VIP members, or people who changed since a date?
      - Which contacts unsubscribed from my audience recently?
      instructions:
      - text: List all members of audience {list_id}.
        slots:
          list_id: path.list_id
      - text: Show members of list {list_id} with status {status}.
        slots:
          list_id: path.list_id
          status: query.status
      - text: List contacts in audience {list_id} that changed since {since_last_changed}.
        slots:
          list_id: path.list_id
          since_last_changed: query.since_last_changed
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new subscriber to an audience
      effect: write
      questions:
      - How do I add a single new subscriber to my list?
      - Can I add a contact as pending so they get a double opt-in confirmation?
      instructions:
      - text: Add {email_address} to audience {list_id} as {status}.
        slots:
          email_address: requestBody.email_address
          list_id: path.list_id
          status: requestBody.status
      - text: Subscribe new contact {email_address} to list {list_id} with tags {tags}.
        slots:
          email_address: requestBody.email_address
          list_id: path.list_id
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/members/{subscriber_hash}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one subscriber's profile
      effect: read
      questions:
      - Is a particular person subscribed, unsubscribed or bounced on my list?
      - What merge field values and interests does one contact have?
      instructions:
      - text: Look up subscriber {subscriber_hash} in audience {list_id}.
        slots:
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      - text: Show the profile and subscription status of member {subscriber_hash} on list {list_id}.
        slots:
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/members/{subscriber_hash}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add or update a subscriber (upsert)
      effect: write
      questions:
      - Can I add a contact if they are new but just update them if they already exist?
      - What status is used for a contact who doesn't exist yet when I upsert them?
      instructions:
      - text: Upsert {email_address} on audience {list_id} as {subscriber_hash}, subscribing them as {status_if_new} if new.
        slots:
          email_address: requestBody.email_address
          list_id: path.list_id
          subscriber_hash: path.subscriber_hash
          status_if_new: requestBody.status_if_new
      - text: Create or update member {subscriber_hash} in list {list_id} with merge fields {merge_fields}.
        slots:
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
          merge_fields: requestBody.merge_fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/members/{subscriber_hash}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive a subscriber
      effect: destructive
      questions:
      - How do I archive a contact so they stop counting toward my audience, without erasing them?
      - Is archiving a member different from permanently deleting them?
      instructions:
      - text: Archive member {subscriber_hash} from audience {list_id}.
        slots:
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      - text: Move contact {subscriber_hash} on list {list_id} to archived.
        slots:
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/members/{subscriber_hash}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing subscriber
      effect: write
      questions:
      - Can I change an existing subscriber's email address or merge fields?
      - How would I unsubscribe one person by changing their status?
      instructions:
      - text: Change the status of member {subscriber_hash} on audience {list_id} to {status}.
        slots:
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
          status: requestBody.status
      - text: Update existing contact {subscriber_hash} in list {list_id} to email {email_address}.
        slots:
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
          email_address: requestBody.email_address
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/members/{subscriber_hash}/activity'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscriber's last 50 activity events
      effect: read
      questions:
      - What were the last 50 opens, clicks or unsubscribes for one contact?
      - Can I filter a subscriber's recent activity to only opens or clicks?
      instructions:
      - text: Show the last 50 activity events for subscriber {subscriber_hash} on audience {list_id}.
        slots:
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      - text: Get only the {action} events from the last 50 for member {subscriber_hash} in list {list_id}.
        slots:
          action: query.action
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/members/{subscriber_hash}/activity-feed'].get
  update:
    x-apievangelist-phrasing:
      intent: Page through a subscriber's full activity feed
      effect: read
      questions:
      - Can I page through a contact's entire activity feed rather than just the last 50 events?
      - Is it possible to filter a member's activity feed by activity type?
      instructions:
      - text: Page through the activity feed of subscriber {subscriber_hash} on audience {list_id}.
        slots:
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      - text: Show the activity feed for member {subscriber_hash} in list {list_id} filtered to {activity_filters}.
        slots:
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
          activity_filters: query.activity_filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/members/{subscriber_hash}/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List the tags on a subscriber
      effect: read
      questions:
      - Which tags are applied to one particular contact?
      - Can I page through all tags on a subscriber if they have many?
      instructions:
      - text: List the tags on subscriber {subscriber_hash} in audience {list_id}.
        slots:
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      - text: Show which tags contact {subscriber_hash} on list {list_id} has.
        slots:
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/members/{subscriber_hash}/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or remove tags on a subscriber
      effect: write
      questions:
      - How do I tag a contact, and will a tag that doesn't exist yet be created?
      - Can I remove a tag from one subscriber by marking it inactive?
      instructions:
      - text: Apply tags {tags} to subscriber {subscriber_hash} on audience {list_id}.
        slots:
          tags: requestBody.tags
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      - text: Remove the tag set {tags} from member {subscriber_hash} in list {list_id}.
        slots:
          tags: requestBody.tags
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/members/{subscriber_hash}/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom events recorded for a contact
      effect: read
      questions:
      - What custom events have been recorded for one contact?
      - Can I see events my app previously sent for a subscriber?
      instructions:
      - text: List the custom events for subscriber {subscriber_hash} in audience {list_id}.
        slots:
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      - text: Show the {count} most recent events logged for member {subscriber_hash} in list {list_id}.
        slots:
          count: query.count
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/members/{subscriber_hash}/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a custom event for a contact
      effect: write
      questions:
      - Can I send a custom event like 'trial_started' for a subscriber to trigger automations?
      - Is it possible to attach properties and a timestamp to an event I log for a contact?
      instructions:
      - text: Record event {name} for subscriber {subscriber_hash} on audience {list_id}.
        slots:
          name: requestBody.name
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      - text: Log event {name} with properties {properties} for member {subscriber_hash} in list {list_id}.
        slots:
          name: requestBody.name
          properties: requestBody.properties
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/members/{subscriber_hash}/goals'].get
  update:
    x-apievangelist-phrasing:
      intent: List a contact's recent goal events
      effect: read
      questions:
      - Which website goal events has a particular subscriber triggered lately?
      - Has one contact reached any of the goals tracked on my website?
      instructions:
      - text: Show the last 50 goal events for subscriber {subscriber_hash} on audience {list_id}.
        slots:
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      - text: List goal events triggered by contact {subscriber_hash} on list {list_id}.
        slots:
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/members/{subscriber_hash}/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List notes on a subscriber
      effect: read
      questions:
      - What notes has my team left on a particular contact?
      - Can I sort a contact's notes by when they were created?
      instructions:
      - text: List recent notes for subscriber {subscriber_hash} in audience {list_id}.
        slots:
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      - text: Show all notes on member {subscriber_hash} in list {list_id}, newest first.
        slots:
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/members/{subscriber_hash}/notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to a subscriber
      effect: write
      questions:
      - Can I attach a free-text note to a subscriber's profile?
      - How do I record a note about a conversation with one subscriber?
      instructions:
      - text: Add the note {note} to subscriber {subscriber_hash} on audience {list_id}.
        slots:
          note: requestBody.note
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      - text: 'Write a new note on contact {subscriber_hash} in list {list_id}: {note}.'
        slots:
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
          note: requestBody.note
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one note on a subscriber
      effect: read
      questions:
      - What does a specific note on a contact say, and who wrote it?
      - Can I fetch a single subscriber note by its note ID?
      instructions:
      - text: Get note {note_id} on subscriber {subscriber_hash} in audience {list_id}.
        slots:
          note_id: path.note_id
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      - text: Show the text of note {note_id} on member {subscriber_hash} of list {list_id}.
        slots:
          note_id: path.note_id
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a note on a subscriber
      effect: destructive
      questions:
      - Is there a way to delete a note I left on a contact by mistake?
      - Can I remove one note from a subscriber's profile without touching the others?
      instructions:
      - text: Delete note {note_id} from subscriber {subscriber_hash} on audience {list_id}.
        slots:
          note_id: path.note_id
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      - text: Remove note {note_id} on contact {subscriber_hash} in list {list_id}.
        slots:
          note_id: path.note_id
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a note on a subscriber
      effect: write
      questions:
      - Can I edit the text of an existing note on a contact?
      - How do I correct a typo in a note already saved on a subscriber?
      instructions:
      - text: Change note {note_id} on subscriber {subscriber_hash} in audience {list_id} to say {note}.
        slots:
          note_id: path.note_id
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
          note: requestBody.note
      - text: Rewrite existing note {note_id} for member {subscriber_hash} of list {list_id} as {note}.
        slots:
          note_id: path.note_id
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
          note: requestBody.note
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent'].post
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a subscriber and their data
      effect: destructive
      questions:
      - How do I permanently erase a contact's personal data for a GDPR request?
      - Can a permanently deleted subscriber ever be re-imported to the list?
      instructions:
      - text: Permanently delete subscriber {subscriber_hash} and all their personal data from audience {list_id}.
        slots:
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      - text: Erase member {subscriber_hash} from list {list_id} for good so they cannot be re-imported.
        slots:
          subscriber_hash: path.subscriber_hash
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/merge-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List an audience's merge fields
      effect: read
      questions:
      - What custom fields like FNAME or BIRTHDAY are defined on my audience?
      - Can I list only the required merge fields on a list?
      instructions:
      - text: List all merge fields on audience {list_id}.
        slots:
          list_id: path.list_id
      - text: Show the merge fields of type {type} on list {list_id}.
        slots:
          type: query.type
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/merge-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a merge field to an audience
      effect: write
      questions:
      - How do I add a new custom field, like a birthday or phone number, to my audience?
      - Can I make a new merge field required and give it a default value?
      instructions:
      - text: Add a {type} merge field called {name} to audience {list_id}.
        slots:
          type: requestBody.type
          name: requestBody.name
          list_id: path.list_id
      - text: Create merge field {name} with tag {tag} on list {list_id}.
        slots:
          name: requestBody.name
          tag: requestBody.tag
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/merge-fields/{merge_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one merge field
      effect: read
      questions:
      - What type, tag and default value does a particular merge field use?
      - Is a given merge field public and required on my signup form?
      instructions:
      - text: Get merge field {merge_id} on audience {list_id}.
        slots:
          merge_id: path.merge_id
          list_id: path.list_id
      - text: Show the type and default value of merge field {merge_id} in list {list_id}.
        slots:
          merge_id: path.merge_id
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/merge-fields/{merge_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a merge field
      effect: destructive
      questions:
      - Can I remove a custom field I no longer collect from my audience?
      - What happens to stored values when I delete a merge field?
      instructions:
      - text: Delete merge field {merge_id} from audience {list_id}.
        slots:
          merge_id: path.merge_id
          list_id: path.list_id
      - text: Remove custom field {merge_id} from list {list_id}.
        slots:
          merge_id: path.merge_id
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/merge-fields/{merge_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a merge field
      effect: write
      questions:
      - How do I rename an existing merge field or change its help text?
      - Can I make an existing merge field required or change its default value?
      instructions:
      - text: Rename merge field {merge_id} on audience {list_id} to {name}.
        slots:
          merge_id: path.merge_id
          list_id: path.list_id
          name: requestBody.name
      - text: Set the help text of existing merge field {merge_id} in list {list_id} to {help_text}.
        slots:
          merge_id: path.merge_id
          list_id: path.list_id
          help_text: requestBody.help_text
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhooks on an audience
      effect: read
      questions:
      - Which webhook URLs are notified when someone subscribes to my list?
      - Does my audience have any webhooks set up already?
      instructions:
      - text: List all webhooks configured on audience {list_id}.
        slots:
          list_id: path.list_id
      - text: Show every webhook URL registered for list {list_id}.
        slots:
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a webhook to an audience
      effect: write
      questions:
      - How can my app get notified when people subscribe, unsubscribe or change their profile?
      - Can I choose which events and sources trigger a new list webhook?
      instructions:
      - text: Add a webhook to audience {list_id} that posts to {url}.
        slots:
          list_id: path.list_id
          url: requestBody.url
      - text: Create a webhook on list {list_id} at {url} for events {events}.
        slots:
          list_id: path.list_id
          url: requestBody.url
          events: requestBody.events
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/webhooks/{webhook_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one audience webhook
      effect: read
      questions:
      - What URL and events is a specific list webhook set up with?
      - Can I check which sources, like admin or API, trigger a given list webhook?
      instructions:
      - text: Get webhook {webhook_id} on audience {list_id}.
        slots:
          webhook_id: path.webhook_id
          list_id: path.list_id
      - text: Show the URL and events of webhook {webhook_id} on list {list_id}.
        slots:
          webhook_id: path.webhook_id
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/webhooks/{webhook_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an audience webhook
      effect: destructive
      questions:
      - How do I stop a list webhook from sending subscribe notifications?
      - Can I remove a webhook that points at an old endpoint on my audience?
      instructions:
      - text: Delete webhook {webhook_id} from audience {list_id}.
        slots:
          webhook_id: path.webhook_id
          list_id: path.list_id
      - text: Remove list webhook {webhook_id} from {list_id}.
        slots:
          webhook_id: path.webhook_id
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/webhooks/{webhook_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an audience webhook
      effect: write
      questions:
      - Can I change the URL or events on a list webhook that already exists?
      - How do I move an existing list webhook to a new endpoint URL?
      instructions:
      - text: Point webhook {webhook_id} on audience {list_id} at {url}.
        slots:
          webhook_id: path.webhook_id
          list_id: path.list_id
          url: requestBody.url
      - text: Change the events on existing list webhook {webhook_id} in {list_id} to {events}.
        slots:
          webhook_id: path.webhook_id
          list_id: path.list_id
          events: requestBody.events
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/signup-forms'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an audience's signup forms
      effect: read
      questions:
      - What does the hosted signup form for my list look like right now?
      - Which header and styles are applied to my audience's signup form?
      instructions:
      - text: Show the signup forms for audience {list_id}.
        slots:
          list_id: path.list_id
      - text: Get the current signup form settings of list {list_id}.
        slots:
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/signup-forms'].post
  update:
    x-apievangelist-phrasing:
      intent: Customize an audience's default signup form
      effect: write
      questions:
      - How do I change the header, text and styles on my list's default signup form?
      - Can I restyle the hosted signup form for one audience?
      instructions:
      - text: Customize the signup form for audience {list_id} with header {header}.
        slots:
          list_id: path.list_id
          header: requestBody.header
      - text: Apply styles {styles} to the default signup form of list {list_id}.
        slots:
          styles: requestBody.styles
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: See which countries subscribers are in
      effect: read
      questions:
      - Which countries are my subscribers located in?
      - Where geographically is my audience, based on their IP addresses?
      instructions:
      - text: Show the subscriber locations by country for audience {list_id}.
        slots:
          list_id: path.list_id
      - text: Which countries are subscribers of list {list_id} in.
        slots:
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/surveys'].get
  update:
    x-apievangelist-phrasing:
      intent: List surveys for an audience
      effect: read
      questions:
      - What surveys have I built for my audience?
      - Which surveys exist for one list, and are they published?
      instructions:
      - text: List all surveys for audience {list_id}.
        slots:
          list_id: path.list_id
      - text: Show the surveys built on list {list_id}.
        slots:
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/surveys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a draft survey
      effect: write
      questions:
      - Can I create a new survey for my subscribers through the API?
      - How do I start a new draft survey for an audience?
      instructions:
      - text: Create a draft survey titled {title} for audience {list_id}.
        slots:
          title: requestBody.title
          list_id: path.list_id
      - text: Start a new survey on list {list_id} with sections {sections}.
        slots:
          list_id: path.list_id
          sections: requestBody.sections
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/surveys/{survey_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one survey
      effect: read
      questions:
      - What questions and status does a particular survey have?
      - Can I fetch one survey's sections and questions by its ID?
      instructions:
      - text: Get survey {survey_id} for audience {list_id}.
        slots:
          survey_id: path.survey_id
          list_id: path.list_id
      - text: Show the sections of survey {survey_id} on list {list_id}.
        slots:
          survey_id: path.survey_id
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/surveys/{survey_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a survey
      effect: destructive
      questions:
      - How can I delete a survey I no longer need?
      - Is deleting a survey from my audience permanent?
      instructions:
      - text: Delete survey {survey_id} from audience {list_id}.
        slots:
          survey_id: path.survey_id
          list_id: path.list_id
      - text: Remove survey {survey_id} on list {list_id}.
        slots:
          survey_id: path.survey_id
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/surveys/{survey_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a survey
      effect: write
      questions:
      - If I update a survey's sections, are sections I leave out deleted?
      - Can I have survey responses piped to my inbox?
      instructions:
      - text: Retitle survey {survey_id} on audience {list_id} to {title}.
        slots:
          survey_id: path.survey_id
          list_id: path.list_id
          title: requestBody.title
      - text: Replace the sections of existing survey {survey_id} in list {list_id} with {sections}.
        slots:
          survey_id: path.survey_id
          list_id: path.list_id
          sections: requestBody.sections
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{list_id}/surveys/{survey_id}/actions/replicate'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate a survey
      effect: write
      questions:
      - Can I copy an existing survey, possibly into a different audience?
      - How do I make a copy of a survey to reuse it?
      instructions:
      - text: Duplicate survey {survey_id} from audience {list_id}.
        slots:
          survey_id: path.survey_id
          list_id: path.list_id
      - text: Replicate survey {survey_id} of list {list_id} as {title}.
        slots:
          survey_id: path.survey_id
          list_id: path.list_id
          title: requestBody.title
      method: generated
      generated: '2026-09-26'