API Evangelist conversational phrasing for GetResponse APIv3 Campaigns (Lists) API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for GetResponse APIv3 Campaigns (Lists) API
  version: 1.0.0
extends: openapi/getresponse-campaigns-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['/campaigns/{campaignId}/blocklists'].get
  update:
    x-apievangelist-phrasing:
      intent: View a list's blocklist masks
      effect: read
      questions:
      - Which emails and domains are blocked from joining one of my GetResponse lists?
      - Can I check whether a specific address pattern is on a list's blocklist?
      instructions:
      - text: Show the blocklist masks for list {campaign}.
        slots:
          campaign: path.campaignId
      - text: Check if {mask} is on the blocklist of list {campaign}.
        slots:
          mask: query.query[mask]
          campaign: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{campaignId}/blocklists'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a list's blocklist masks
      effect: write
      questions:
      - Can I block certain email domains from subscribing to one specific list?
      - What happens to a list's existing blocked addresses when I send new masks?
      instructions:
      - text: Set the blocklist of list {campaign} to {masks}.
        slots:
          campaign: path.campaignId
          masks: requestBody.masks
      - text: Block the masks {masks} from joining list {campaign}.
        slots:
          masks: requestBody.masks
          campaign: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{campaignId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one contact list's details
      effect: read
      questions:
      - Where can I see the full settings of a single contact list?
      - What confirmation and profile settings does one of my lists have?
      instructions:
      - text: Get the details of list {campaign}.
        slots:
          campaign: path.campaignId
      - text: Show only the {fields} of list {campaign}.
        slots:
          fields: query.fields
          campaign: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{campaignId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a contact list's settings
      effect: write
      questions:
      - Can I rename or reconfigure an existing contact list?
      - Is it possible to change the opt-in settings on a list I already created?
      instructions:
      - text: Update the settings of list {campaign}.
        slots:
          campaign: path.campaignId
      - text: Edit list {campaign} so its configuration matches what I describe.
        slots:
          campaign: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: List my contact lists
      effect: read
      questions:
      - What contact lists do I have in my GetResponse account?
      - Which of my lists is set as the default one?
      - Can I sort my lists by the date they were created?
      instructions:
      - text: List all my contact lists.
      - text: Find my contact lists named {name}.
        slots:
          name: query.query[name]
      - text: Show page {page} of my lists, {perPage} per page.
        slots:
          page: query.page
          perPage: query.perPage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new contact list
      effect: write
      questions:
      - How do I set up a brand new contact list for subscribers?
      - Is there a cap on how many contact lists one account can have?
      instructions:
      - text: Create a new contact list for my newsletter subscribers.
      - text: Make a fresh contact list with the name and settings I give you.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/statistics/origins'].get
  update:
    x-apievangelist-phrasing:
      intent: See where a list's subscribers came from
      effect: read
      questions:
      - Which sources, like forms or imports, brought subscribers into my list?
      - Can I break down subscriber origins for a list over a date range?
      instructions:
      - text: Show subscriber origin stats for list {campaign}.
        slots:
          campaign: query.query[campaignId]
      - text: Break down where subscribers to list {campaign} came from between {from} and {to}.
        slots:
          campaign: query.query[campaignId]
          from: query.query[createdOn][from]
          to: query.query[createdOn][to]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/statistics/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: See subscriber locations for a list
      effect: read
      questions:
      - What countries are the subscribers on my list located in?
      - Can I get a geographic breakdown of a list's audience?
      instructions:
      - text: Show subscriber location stats for list {campaign}.
        slots:
          campaign: query.query[campaignId]
      - text: Break down the locations of people who joined list {campaign} since {from}.
        slots:
          campaign: query.query[campaignId]
          from: query.query[createdOn][from]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/statistics/list-size'].get
  update:
    x-apievangelist-phrasing:
      intent: Track a list's size over time
      effect: read
      questions:
      - How big has my contact list grown over time?
      - Can I see total added and removed subscribers for a list grouped by period?
      instructions:
      - text: Show the size history of list {campaign}.
        slots:
          campaign: query.query[campaignId]
      - text: Report list size for list {campaign} grouped by {groupBy}.
        slots:
          campaign: query.query[campaignId]
          groupBy: query.query[groupBy]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/statistics/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: Count new subscriptions to a list per day
      effect: read
      questions:
      - How many people subscribed to my list each day, and through what channel?
      - What were the daily new subscription counts for a list last month?
      instructions:
      - text: Show daily new subscriptions for list {campaign}.
        slots:
          campaign: query.query[campaignId]
      - text: Count subscriptions to list {campaign} from {from} to {to}.
        slots:
          campaign: query.query[campaignId]
          from: query.query[createdOn][from]
          to: query.query[createdOn][to]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/statistics/removals'].get
  update:
    x-apievangelist-phrasing:
      intent: See why contacts left a list
      effect: read
      questions:
      - Why are contacts being removed from my list, and how many?
      - Can I see unsubscribes and other removal reasons by date?
      instructions:
      - text: Show removal stats and reasons for list {campaign}.
        slots:
          campaign: query.query[campaignId]
      - text: Report contacts removed from list {campaign} between {from} and {to}.
        slots:
          campaign: query.query[campaignId]
          from: query.query[createdOn][from]
          to: query.query[createdOn][to]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/statistics/balance'].get
  update:
    x-apievangelist-phrasing:
      intent: See a list's net subscription balance
      effect: read
      questions:
      - Is my list gaining or losing subscribers on balance?
      - What is the net change of subscriptions versus removals per day for a list?
      instructions:
      - text: Show the subscription balance for list {campaign}.
        slots:
          campaign: query.query[campaignId]
      - text: Report the net subscriber balance of list {campaign} grouped by {groupBy}.
        slots:
          campaign: query.query[campaignId]
          groupBy: query.query[groupBy]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/statistics/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stats summary for my lists
      effect: read
      questions:
      - Can I get a quick overview of the key numbers for several lists at once?
      - What does the overall statistics summary say about my lists?
      instructions:
      - text: Give me the statistics summary for list {campaign}.
        slots:
          campaign: query.query[campaignId]
      - text: Summarize the stats across my contact lists.
      method: generated
      generated: '2026-09-26'