# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for AWeber Subscribers API
  version: 1.0.0
extends: openapi/aweber-subscribers-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 12
- target: $.paths['/accounts/{accountId}/lists/{listId}/subscribers'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscribers on a list
      effect: read
      questions:
      - Who is subscribed to my list, oldest signups first?
      - Can I list a list's subscribers newest first instead of oldest first?
      instructions:
      - text: List the subscribers on list {listId} in account {accountId}.
        slots:
          listId: path.listId
          accountId: path.accountId
      - text: Show every subscriber on list {listId}, account {accountId}, in {sort_order} order of signup.
        slots:
          listId: path.listId
          accountId: path.accountId
          sort_order: query.sort_order
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/subscribers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a subscriber to a list
      effect: write
      questions:
      - How do I add a new email subscriber to my AWeber list?
      - Can I tag a new subscriber and set custom field values when I add them?
      - What should I use instead of this endpoint for importing a very large list?
      instructions:
      - text: Add {email} as a new subscriber to list {listId} in account {accountId}.
        slots:
          email: requestBody.email
          listId: path.listId
          accountId: path.accountId
      - text: Subscribe {name} at {email} to list {listId}, account {accountId}, and tag them {tags}.
        slots:
          name: requestBody.name
          email: requestBody.email
          listId: path.listId
          accountId: path.accountId
          tags: requestBody.tags
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/subscribers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a subscriber by email address
      effect: destructive
      questions:
      - How do I permanently delete a subscriber when I only have their email address?
      - What's the difference between deleting a subscriber and just unsubscribing them?
      instructions:
      - text: Delete the subscriber with email {subscriber_email} from list {listId} in account {accountId}.
        slots:
          subscriber_email: query.subscriber_email
          listId: path.listId
          accountId: path.accountId
      - text: Permanently remove {subscriber_email} and their data from list {listId}, account {accountId}.
        slots:
          subscriber_email: query.subscriber_email
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/subscribers'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a subscriber found by email address
      effect: write
      questions:
      - Can I update a subscriber's details using their email address instead of their ID?
      - How can I unsubscribe someone by email without deleting their record?
      instructions:
      - text: Set the status of subscriber {subscriber_email} on list {listId} in account {accountId} to {status}.
        slots:
          subscriber_email: query.subscriber_email
          listId: path.listId
          accountId: path.accountId
          status: requestBody.status
      - text: Change the name of the subscriber with email {subscriber_email} on list {listId}, account {accountId}, to {name}.
        slots:
          subscriber_email: query.subscriber_email
          listId: path.listId
          accountId: path.accountId
          name: requestBody.name
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/subscribers/{subscriberId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one subscriber by ID
      effect: read
      questions:
      - What details are stored for one subscriber, like tags and custom fields?
      - Can I look up a subscriber's record when I have their subscriber ID?
      instructions:
      - text: Show subscriber {subscriberId} on list {listId} in account {accountId}.
        slots:
          subscriberId: path.subscriberId
          listId: path.listId
          accountId: path.accountId
      - text: Get the full record of subscriber {subscriberId} from list {listId}, account {accountId}.
        slots:
          subscriberId: path.subscriberId
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/subscribers/{subscriberId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a subscriber to another list
      effect: write
      questions:
      - Can I move a subscriber from one list to another without sending a new confirmation email?
      - Where does a moved subscriber start in the destination list's followup sequence?
      instructions:
      - text: Move subscriber {subscriberId} from list {listId} in account {accountId} to the list at {list_link}.
        slots:
          subscriberId: path.subscriberId
          listId: path.listId
          accountId: path.accountId
          list_link: requestBody.list_link
      - text: Transfer subscriber {subscriberId} off list {listId}, account {accountId}, onto {list_link} using {op}.
        slots:
          subscriberId: path.subscriberId
          listId: path.listId
          accountId: path.accountId
          list_link: requestBody.list_link
          op: requestBody.ws.op
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/subscribers/{subscriberId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a subscriber by ID
      effect: destructive
      questions:
      - How do I delete a subscriber and their history using their subscriber ID?
      - Is deleting a subscriber by ID reversible?
      instructions:
      - text: Delete subscriber {subscriberId} from list {listId} in account {accountId}.
        slots:
          subscriberId: path.subscriberId
          listId: path.listId
          accountId: path.accountId
      - text: Permanently erase subscriber ID {subscriberId} and related data on list {listId}, account {accountId}.
        slots:
          subscriberId: path.subscriberId
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/subscribers/{subscriberId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a subscriber by ID
      effect: write
      questions:
      - Can I add or remove tags on a subscriber when I know their subscriber ID?
      - How do I change a subscriber's email address using their ID?
      instructions:
      - text: Update the tags on subscriber {subscriberId} on list {listId} in account {accountId} to {tags}.
        slots:
          subscriberId: path.subscriberId
          listId: path.listId
          accountId: path.accountId
          tags: requestBody.tags
      - text: Change the email of subscriber ID {subscriberId} on list {listId}, account {accountId}, to {email}.
        slots:
          subscriberId: path.subscriberId
          listId: path.listId
          accountId: path.accountId
          email: requestBody.email
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/subscribers?ws.op=find'].get
  update:
    x-apievangelist-phrasing:
      intent: Search subscribers within one list
      effect: read
      questions:
      - Which subscribers on a single list have a particular tag?
      - Can I find people on one list who subscribed after a certain date?
      - Does the subscriber search on a list support partial matches?
      instructions:
      - text: Find subscribers on list {listId} in account {accountId} tagged {tags}.
        slots:
          listId: path.listId
          accountId: path.accountId
          tags: query.tags
      - text: Search list {listId}, account {accountId}, for subscribers who joined after {subscribed_after} with status {status}.
        slots:
          listId: path.listId
          accountId: path.accountId
          subscribed_after: query.subscribed_after
          status: query.status
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}?ws.op=findSubscribers'].get
  update:
    x-apievangelist-phrasing:
      intent: Search subscribers across all lists
      effect: read
      questions:
      - Which lists in my account is a given email address subscribed to?
      - Can I search for a subscriber across every list at once?
      instructions:
      - text: Find {email} across all lists in account {accountId}.
        slots:
          email: query.email
          accountId: path.accountId
      - text: Search every list in account {accountId} for subscribers in {country} with status {status}.
        slots:
          accountId: path.accountId
          country: query.country
          status: query.status
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/subscribers/{subscriberId}?ws.op=getActivity'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscriber's activity history
      effect: read
      questions:
      - What emails has a subscriber been sent, opened and clicked?
      - When did a particular subscriber join and verify their subscription?
      instructions:
      - text: Show the activity timeline for subscriber {subscriberId} on list {listId} in account {accountId}.
        slots:
          subscriberId: path.subscriberId
          listId: path.listId
          accountId: path.accountId
      - text: List the sends, opens and clicks for subscriber {subscriberId}, list {listId}, account {accountId}, using {op}.
        slots:
          subscriberId: path.subscriberId
          listId: path.listId
          accountId: path.accountId
          op: query.ws.op
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/purchases'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a purchase for a subscriber
      effect: write
      questions:
      - How do I track a sale made by an email subscriber?
      - Will recording a purchase create the subscriber if they don't exist yet?
      - Does logging a purchase count more than once against my rate limit?
      instructions:
      - text: Record a {value} {currency} purchase of {product_name} from {vendor} by {email} on list {listId} in account {accountId}.
        slots:
          value: requestBody.value
          currency: requestBody.currency
          product_name: requestBody.product_name
          vendor: requestBody.vendor
          email: requestBody.email
          listId: path.listId
          accountId: path.accountId
      - text: Log a purchase for {email} from IP {ip_address} at {event_time}, page {url}, note {event_note}, on list {listId}, account {accountId}.
        slots:
          email: requestBody.email
          ip_address: requestBody.ip_address
          event_time: requestBody.event_time
          url: requestBody.url
          event_note: requestBody.event_note
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'