# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for AWeber Broadcasts API
  version: 1.0.0
extends: openapi/aweber-broadcasts-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: 10
- target: $.paths['/accounts/{accountId}/lists/{listId}/broadcasts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a list's broadcasts by status
      effect: read
      questions:
      - Which broadcast emails are currently scheduled to go out to my list?
      - Can I list only the draft broadcasts I created through the API?
      - What newsletters have already been sent to this list?
      instructions:
      - text: List the {status} broadcasts on list {listId} in account {accountId}.
        slots:
          status: query.status
          listId: path.listId
          accountId: path.accountId
      - text: Show the next {size} {status} broadcasts for list {listId} in account {accountId}.
        slots:
          size: query.ws.size
          status: query.status
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/broadcasts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a broadcast draft
      effect: write
      questions:
      - How do I create a new broadcast email draft for my AWeber list?
      - Can a new broadcast include an AMP version alongside the HTML and plain text bodies?
      - Is there a size limit on the broadcast draft I submit?
      instructions:
      - text: Create a broadcast draft on list {listId} in account {accountId} with subject {subject}, HTML {body_html} and text {body_text}.
        slots:
          listId: path.listId
          accountId: path.accountId
          subject: requestBody.subject
          body_html: requestBody.body_html
          body_text: requestBody.body_text
      - text: Draft a new broadcast for list {listId} in account {accountId} titled {subject}, body {body_html} / {body_text}, also sent to lists {include_lists}.
        slots:
          listId: path.listId
          accountId: path.accountId
          subject: requestBody.subject
          body_html: requestBody.body_html
          body_text: requestBody.body_text
          include_lists: requestBody.include_lists
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/broadcasts/{broadcastId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one broadcast message
      effect: read
      questions:
      - What subject and content does a specific broadcast have?
      - Can I check the current status of one broadcast I created?
      instructions:
      - text: Show broadcast {broadcastId} on list {listId} in account {accountId}.
        slots:
          broadcastId: path.broadcastId
          listId: path.listId
          accountId: path.accountId
      - text: Get the details of broadcast {broadcastId} from list {listId}, account {accountId}.
        slots:
          broadcastId: path.broadcastId
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/broadcasts/{broadcastId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace the content of a broadcast draft
      effect: write
      questions:
      - Can I edit a broadcast draft after I've created it through the API?
      - Why can't I update a draft broadcast that was made in the web editor?
      instructions:
      - text: Change the subject of draft broadcast {broadcastId} on list {listId} in account {accountId} to {subject}.
        slots:
          broadcastId: path.broadcastId
          listId: path.listId
          accountId: path.accountId
          subject: requestBody.subject
      - text: Replace the HTML body of existing draft {broadcastId} on list {listId}, account {accountId}, with {body_html}.
        slots:
          broadcastId: path.broadcastId
          listId: path.listId
          accountId: path.accountId
          body_html: requestBody.body_html
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/broadcasts/{broadcastId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a broadcast draft
      effect: destructive
      questions:
      - How do I delete a broadcast draft I no longer need?
      - Which broadcast drafts am I allowed to delete through the API?
      instructions:
      - text: Delete draft broadcast {broadcastId} from list {listId} in account {accountId}.
        slots:
          broadcastId: path.broadcastId
          listId: path.listId
          accountId: path.accountId
      - text: Throw away the API-created draft {broadcastId} on list {listId}, account {accountId}.
        slots:
          broadcastId: path.broadcastId
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/broadcasts/{broadcastId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a scheduled broadcast
      effect: destructive
      questions:
      - Can I stop a broadcast that's scheduled but hasn't been sent yet?
      - What happens if I need to unschedule a newsletter at the last minute?
      instructions:
      - text: Cancel scheduled broadcast {broadcastId} on list {listId} in account {accountId}.
        slots:
          broadcastId: path.broadcastId
          listId: path.listId
          accountId: path.accountId
      - text: Unschedule broadcast {broadcastId} for list {listId}, account {accountId}, so it doesn't send.
        slots:
          broadcastId: path.broadcastId
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/broadcasts/total'].get
  update:
    x-apievangelist-phrasing:
      intent: Count broadcasts in a given status
      effect: read
      questions:
      - How many sent broadcasts does my list have in total?
      - What's the count of drafts waiting on a list, without fetching them all?
      instructions:
      - text: Return only the total count of {status} broadcasts on list {listId} in account {accountId}, not the broadcasts themselves.
        slots:
          status: query.status
          listId: path.listId
          accountId: path.accountId
      - text: Give me the total number of {status} broadcasts for list {listId}, account {accountId}.
        slots:
          status: query.status
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/broadcasts/{broadcastId}/schedule'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a broadcast to send
      effect: write
      questions:
      - How do I set a send time for a broadcast draft?
      - Can I schedule a newsletter to go out at a specific date and time?
      instructions:
      - text: Schedule broadcast {broadcastId} on list {listId} in account {accountId} to send at {scheduled_for}.
        slots:
          broadcastId: path.broadcastId
          listId: path.listId
          accountId: path.accountId
          scheduled_for: requestBody.scheduled_for
      - text: Send broadcast {broadcastId} to list {listId}, account {accountId}, at {scheduled_for}.
        slots:
          broadcastId: path.broadcastId
          listId: path.listId
          accountId: path.accountId
          scheduled_for: requestBody.scheduled_for
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/broadcasts/{broadcastId}/opens'].get
  update:
    x-apievangelist-phrasing:
      intent: List who opened a broadcast
      effect: read
      questions:
      - Which subscribers opened a particular broadcast email?
      - If someone opened the newsletter several times, which open gets recorded?
      - Why don't I see subscriber email addresses in the broadcast opens?
      instructions:
      - text: List the unique opens for broadcast {broadcastId} on list {listId} in account {accountId}.
        slots:
          broadcastId: path.broadcastId
          listId: path.listId
          accountId: path.accountId
      - text: Show {page_size} subscribers who opened broadcast {broadcastId}, list {listId}, account {accountId}.
        slots:
          page_size: query.page_size
          broadcastId: path.broadcastId
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/broadcasts/{broadcastId}/clicks'].get
  update:
    x-apievangelist-phrasing:
      intent: List link clicks on a broadcast
      effect: read
      questions:
      - Who clicked links in my broadcast email?
      - Can I see exactly which URLs each subscriber clicked, not just the first click?
      instructions:
      - text: List the clicks on broadcast {broadcastId} on list {listId} in account {accountId}.
        slots:
          broadcastId: path.broadcastId
          listId: path.listId
          accountId: path.accountId
      - text: Show every individual click event with URLs for broadcast {broadcastId}, list {listId}, account {accountId}, detailed={detailed}.
        slots:
          broadcastId: path.broadcastId
          listId: path.listId
          accountId: path.accountId
          detailed: query.detailed
      method: generated
      generated: '2026-10-02'