# 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 Email address API
  version: 1.0.0
extends: openapi/sendpulse-email-address-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: 9
- target: $.paths['/addressbooks/{id}/emails/variable'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a subscriber's variables in a mailing list
      effect: write
      questions:
      - How do I change custom field values for one subscriber in a mailing list?
      - Can I update a contact's variables like name or city inside a specific list?
      instructions:
      - text: Set variables {variables} for {email} in mailing list {id}.
        slots:
          variables: requestBody.variables
          email: requestBody.email
          id: path.id
      - text: Update the custom fields of subscriber {email} in address book {id} to {variables}.
        slots:
          email: requestBody.email
          id: path.id
          variables: requestBody.variables
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails/{email}'].get
  update:
    x-apievangelist-phrasing:
      intent: Find which mailing lists an email belongs to
      effect: read
      questions:
      - Which mailing lists is this email address subscribed to?
      - Can I check whether an address is on any of my lists?
      instructions:
      - text: Find which mailing lists {email} belongs to.
        slots:
          email: path.email
      - text: Check whether {email} is on any of my address books.
        slots:
          email: path.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails/{email}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an email from all mailing lists
      effect: destructive
      questions:
      - How do I wipe a subscriber from every mailing list at once?
      - Can I delete an email address across my whole account?
      instructions:
      - text: Delete {email} from all my mailing lists.
        slots:
          email: path.email
      - text: Wipe subscriber {email} everywhere in my account.
        slots:
          email: path.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails/{email}/details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get list membership details for an email
      effect: read
      questions:
      - When and from what source was this email added to my lists?
      - What list names and addition dates are recorded for a subscriber?
      instructions:
      - text: Show the detailed list membership of {email}, including addition dates and sources.
        slots:
          email: path.email
      - text: Tell me when and how {email} was added to each list.
        slots:
          email: path.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails'].post
  update:
    x-apievangelist-phrasing:
      intent: Check subscriber status for many emails at once
      effect: read
      questions:
      - Can I check the subscription status of a batch of email addresses in one call?
      - What lists are a group of addresses on?
      instructions:
      - text: Check the subscriber status of {emails}.
        slots:
          emails: requestBody.emails
      - text: 'Look up list membership for these addresses in bulk: {emails}.'
        slots:
          emails: requestBody.emails
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails/{email}/campaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: Get campaign engagement stats for one subscriber
      effect: read
      questions:
      - Which campaigns did a particular subscriber open or click?
      - Can I see email analytics for a single contact?
      instructions:
      - text: Show campaign engagement stats for {email}.
        slots:
          email: path.email
      - text: How has {email} interacted with my campaigns; get the numbers
        slots:
          email: path.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaigns/{id}/email/{email}'].get
  update:
    x-apievangelist-phrasing:
      intent: See what happened to an email in one campaign
      effect: read
      questions:
      - Did a specific recipient open or bounce a particular campaign?
      - Can I check the delivery result for one address within a campaign?
      instructions:
      - text: Show what happened to {email} in campaign {id}.
        slots:
          email: path.email
          id: path.id
      - text: Check whether {email} opened campaign {id}.
        slots:
          email: path.email
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addressbooks/{id}/emails/{email}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscriber's status and variables in one list
      effect: read
      questions:
      - What variables and status does a subscriber have in a specific mailing list?
      - Is this email active in one particular address book?
      instructions:
      - text: Show the status and variables of {email} in mailing list {id}.
        slots:
          email: path.email
          id: path.id
      - text: Get the record for {email} in address book {id}.
        slots:
          email: path.email
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/emails/campaigns'].post
  update:
    x-apievangelist-phrasing:
      intent: Get campaign engagement stats for many emails
      effect: read
      questions:
      - Can I pull open and click stats for a batch of subscribers at once?
      - Which of these contacts engaged with my campaigns?
      instructions:
      - text: Get campaign engagement stats for {emails}.
        slots:
          emails: requestBody.emails
      - text: Fetch bulk campaign activity for addresses {emails}.
        slots:
          emails: requestBody.emails
      method: generated
      generated: '2026-10-01'