# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for SendPulse Bulk Email Mailing lists API
  version: 1.0.0
extends: openapi/sendpulse-mailing-lists-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 14
- target: $.paths['/addressbooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List mailing lists
      effect: read
      questions:
      - What mailing lists do I have in my account?
      - Can I page through my address books with limit and offset?
      instructions:
      - text: List my mailing lists.
      - text: Show {limit} mailing lists starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addressbooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a mailing list
      effect: write
      questions:
      - How do I create a new mailing list?
      - Can I set up a fresh address book for a campaign?
      instructions:
      - text: Create a mailing list called {bookName}.
        slots:
          bookName: requestBody.bookName
      - text: Make a new address book named {bookName}.
        slots:
          bookName: requestBody.bookName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addressbooks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a mailing list's details
      effect: read
      questions:
      - What details are available about one specific mailing list?
      - Can I check a single address book's information by ID?
      instructions:
      - text: Get details for mailing list {id}.
        slots:
          id: path.id
      - text: Show me information about address book {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addressbooks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a mailing list
      effect: write
      questions:
      - Can I rename an existing mailing list?
      - Is there a way to change an address book's name?
      instructions:
      - text: Rename mailing list {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the name of address book {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addressbooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a mailing list
      effect: destructive
      questions:
      - How do I permanently delete a mailing list?
      - Is deleting an address book reversible?
      instructions:
      - text: Delete mailing list {id}.
        slots:
          id: path.id
      - text: Permanently remove address book {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addressbooks/{id}/variables'].get
  update:
    x-apievangelist-phrasing:
      intent: List a mailing list's variables
      effect: read
      questions:
      - Which variables are defined on a mailing list?
      - Can I see the custom fields available for contacts in an address book?
      instructions:
      - text: List the variables on mailing list {id}.
        slots:
          id: path.id
      - text: Show custom fields for address book {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addressbooks/{id}/emails'].get
  update:
    x-apievangelist-phrasing:
      intent: List contacts in a mailing list
      effect: read
      questions:
      - How do I get all the email contacts in a mailing list?
      - Can I list only active or only inactive subscribers of a list?
      instructions:
      - text: List the emails in mailing list {id}.
        slots:
          id: path.id
      - text: Show {limit} contacts from address book {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addressbooks/{id}/emails'].post
  update:
    x-apievangelist-phrasing:
      intent: Add contacts to a mailing list
      effect: write
      questions:
      - Can I add subscribers to a mailing list with double opt-in?
      - What's the way to import email addresses into an existing list?
      instructions:
      - text: Add contacts to mailing list {id}.
        slots:
          id: path.id
      - text: Import these emails into address book {id} with single opt-in.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addressbooks/{id}/emails'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove email addresses from a mailing list
      effect: destructive
      questions:
      - How do I delete specific email addresses from a mailing list?
      - Can I remove several contacts from one list at once?
      instructions:
      - text: Delete {emails} from mailing list {id}.
        slots:
          emails: requestBody.emails
          id: path.id
      - text: Remove these addresses {emails} from address book {id}.
        slots:
          emails: requestBody.emails
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addressbooks/{id}/emails/total'].get
  update:
    x-apievangelist-phrasing:
      intent: Count contacts in a mailing list
      effect: read
      questions:
      - How many contacts are in a mailing list?
      - Can I count just the active subscribers of a list?
      instructions:
      - text: Count the contacts in mailing list {id}.
        slots:
          id: path.id
      - text: Give me the total number of emails in address book {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addressbooks/{id}/emails/unsubscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe contacts from a mailing list
      effect: write
      questions:
      - Can I mark contacts as unsubscribed in one list without deleting them?
      - What's the way to opt people out of a single mailing list?
      instructions:
      - text: Unsubscribe {emails} from mailing list {id}.
        slots:
          emails: requestBody.emails
          id: path.id
      - text: Move {emails} to unsubscribed in address book {id}.
        slots:
          emails: requestBody.emails
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addressbooks/{id}/variables/{variableName}/{searchValue}'].get
  update:
    x-apievangelist-phrasing:
      intent: Find list contacts by variable value
      effect: read
      questions:
      - Can I find contacts in a list whose custom variable equals a certain value?
      - Which subscribers in an address book have city set to Berlin?
      instructions:
      - text: Find contacts in mailing list {id} where {variableName} is {searchValue}.
        slots:
          id: path.id
          variableName: path.variableName
          searchValue: path.searchValue
      - text: Search address book {id} for {variableName} = {searchValue}.
        slots:
          id: path.id
          variableName: path.variableName
          searchValue: path.searchValue
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addressbooks/{id}/phone'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a subscriber's phone number
      effect: write
      questions:
      - Can I update the phone number stored for a subscriber in a list?
      - Is there a way to edit a contact's Phone variable by email?
      instructions:
      - text: Set the phone for {email} in mailing list {id} to {phone}.
        slots:
          email: requestBody.email
          id: path.id
          phone: requestBody.phone
      - text: Change subscriber {email}'s phone number to {phone} in list {id}.
        slots:
          email: requestBody.email
          phone: requestBody.phone
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addressbooks/{id}/cost'].get
  update:
    x-apievangelist-phrasing:
      intent: Estimate the cost of sending to a list
      effect: read
      questions:
      - How much would it cost to send a campaign to this mailing list?
      - Can I calculate the price of a mailing before sending it?
      instructions:
      - text: Calculate the campaign cost for mailing list {id}.
        slots:
          id: path.id
      - text: Estimate what sending to address book {id} will cost.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'