# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Brevo Senders API
  version: 1.0.0
extends: openapi/brevo-senders-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: 7
- target: $.paths['/senders'].get
  update:
    x-apievangelist-phrasing:
      intent: List email senders
      effect: read
      questions:
      - Which sender addresses can I use for my Brevo campaigns?
      - Can I list only the senders on a particular domain?
      instructions:
      - text: List all my email senders.
      - text: List senders on domain {domain}.
        slots:
          domain: query.domain
      - text: List senders using dedicated IP {ip}.
        slots:
          ip: query.ip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/senders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email sender
      effect: write
      questions:
      - How do I add a new From name and address for campaigns?
      - Can I tie a new sender to specific dedicated IPs?
      instructions:
      - text: Create a sender named {name} with email {email}.
        slots:
          name: requestBody.name
          email: requestBody.email
      - text: Add sender {name} <{email}> on dedicated IPs {ips}.
        slots:
          name: requestBody.name
          email: requestBody.email
          ips: requestBody.ips
      method: generated
      generated: '2026-09-26'
- target: $.paths['/senders/{senderId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an email sender
      effect: write
      questions:
      - Can I change the display name on an existing sender?
      - How do I update which dedicated IPs a sender uses?
      instructions:
      - text: Change the display name of sender {senderId} to {name}.
        slots:
          senderId: path.senderId
          name: requestBody.name
      - text: Assign dedicated IPs {ips} to sender {senderId}.
        slots:
          ips: requestBody.ips
          senderId: path.senderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/senders/{senderId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email sender
      effect: destructive
      questions:
      - How do I remove a duplicate sender address?
      - Can I delete a sender I no longer use?
      instructions:
      - text: Delete sender {senderId}.
        slots:
          senderId: path.senderId
      - text: Remove sender {senderId} from my account.
        slots:
          senderId: path.senderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/senders/{senderId}/validate'].put
  update:
    x-apievangelist-phrasing:
      intent: Verify a sender with a one-time code
      effect: write
      questions:
      - How do I verify a new sender with the code I got by email?
      - What do I do with the OTP sent to my sender address?
      instructions:
      - text: Validate sender {senderId} with code {otp}.
        slots:
          senderId: path.senderId
          otp: requestBody.otp
      - text: Activate sender {senderId} using one-time password {otp}.
        slots:
          senderId: path.senderId
          otp: requestBody.otp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/senders/ips'].get
  update:
    x-apievangelist-phrasing:
      intent: List the account's dedicated IPs
      effect: read
      questions:
      - Which dedicated sending IPs does my account have?
      - Are my dedicated IPs active?
      instructions:
      - text: List all dedicated IPs on my account.
      - text: Show the status of every dedicated IP using API key {api_key}.
        slots:
          api_key: header.api-key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/senders/{senderId}/ips'].get
  update:
    x-apievangelist-phrasing:
      intent: List dedicated IPs for one sender
      effect: read
      questions:
      - Which dedicated IPs does a particular sender send from?
      - Can I check a single sender's IP configuration?
      instructions:
      - text: List the dedicated IPs of sender {senderId}.
        slots:
          senderId: path.senderId
      - text: Check which IPs sender {senderId} is tied to.
        slots:
          senderId: path.senderId
      method: generated
      generated: '2026-09-26'