# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Brevo Transactional Email Transactional Emails API
  version: 1.0.0
extends: openapi/brevo-transactional-emails-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: 24
- target: $.paths['/smtp/email'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a transactional email
      effect: write
      questions:
      - How do I send a password reset email from my app?
      - Can I schedule a transactional email or attach files?
      - Is it possible to send using a saved template with dynamic parameters?
      instructions:
      - text: Send an email from {sender} to {to} with subject {subject}.
        slots:
          sender: requestBody.sender
          to: requestBody.to
          subject: requestBody.subject
      - text: Email {to} from {sender} using template {templateId} with params {params}.
        slots:
          to: requestBody.to
          sender: requestBody.sender
          templateId: requestBody.templateId
          params: requestBody.params
      - text: Schedule an email from {sender} to {to} for {scheduledAt}.
        slots:
          sender: requestBody.sender
          to: requestBody.to
          scheduledAt: requestBody.scheduledAt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/smtp/email/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Send many transactional emails in one call
      effect: write
      questions:
      - Can I send different personalized emails to many recipients in one request?
      - What lets each email in a batch have its own content and parameters?
      instructions:
      - text: Batch send these email versions {messageVersions}.
        slots:
          messageVersions: requestBody.messageVersions
      - text: Send the batch of personalized emails {messageVersions} in one call.
        slots:
          messageVersions: requestBody.messageVersions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/smtp/email/{messageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the content of a sent email
      effect: read
      questions:
      - What exactly did a customer receive in a transactional email I sent?
      - Can I view the rendered HTML of a sent message?
      instructions:
      - text: Show the content of sent email {messageId}.
        slots:
          messageId: path.messageId
      - text: Get the rendered subject and body of message {messageId}.
        slots:
          messageId: path.messageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/smtp/emails'].get
  update:
    x-apievangelist-phrasing:
      intent: List sent transactional emails
      effect: read
      questions:
      - Which transactional emails did we send to a particular address in the last 30 days?
      - Can I find every sent email that used a certain template?
      instructions:
      - text: List transactional emails sent to {email}.
        slots:
          email: query.email
      - text: List transactional emails sent with template {templateId} between {startDate} and {endDate}.
        slots:
          templateId: query.templateId
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/emails/{uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the personalized content of a sent email
      effect: read
      questions:
      - Which version of an email, with their own merge values, did one recipient get, looked up by the uuid from the logs?
      - Can I view the rendered body of one sent email by its uuid?
      instructions:
      - text: Pull the per-recipient personalized email for log uuid {uuid}.
        slots:
          uuid: path.uuid
      - text: Fetch the rendered body the recipient saw for email {uuid}.
        slots:
          uuid: path.uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/email/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel scheduled transactional emails
      effect: destructive
      questions:
      - How do I cancel a transactional email I scheduled but haven't sent yet?
      - Can I delete an entire scheduled batch by its batchId?
      instructions:
      - text: Delete the scheduled email or batch {identifier}.
        slots:
          identifier: path.identifier
      - text: Cancel scheduled batch {identifier} before it goes out.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/emailStatus/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of scheduled emails
      effect: read
      questions:
      - Has my scheduled batch of transactional emails been sent yet?
      - Can I filter a scheduled batch to see only the emails still in queue?
      instructions:
      - text: Fetch the status of scheduled batch or message {identifier}.
        slots:
          identifier: path.identifier
      - text: Show the emails in scheduled batch {identifier} with status {status}.
        slots:
          identifier: path.identifier
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/deleteHardbounces'].post
  update:
    x-apievangelist-phrasing:
      intent: Clear hard bounces
      effect: destructive
      questions:
      - Can I remove hard bounces caused by a temporary ISP outage?
      - How do I clear the hard bounce record for one contact's email?
      instructions:
      - text: Delete hard bounces recorded for {contactEmail}.
        slots:
          contactEmail: requestBody.contactEmail
      - text: Delete all hard bounces logged between {startDate} and {endDate}.
        slots:
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/statistics/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: Get daily transactional email stats
      effect: read
      questions:
      - What were my transactional email delivery and open numbers per day this week?
      - Can I get day-by-day email stats for one tag only?
      instructions:
      - text: Show my transactional email stats per day for the last {days} days.
        slots:
          days: query.days
      - text: Give me the day-by-day transactional report for tag {tag} from {startDate} to {endDate}.
        slots:
          tag: query.tag
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/statistics/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List individual transactional email events
      effect: read
      questions:
      - Which transactional emails to one address bounced or were opened, event by event?
      - Can I see the raw delivery, open and click events for a single message id?
      - How far back can I pull unaggregated email events?
      instructions:
      - text: List every transactional email event for {email} in the last {days} days.
        slots:
          email: query.email
          days: query.days
      - text: Show the {event} events for transactional emails sent with template {templateId}.
        slots:
          event: query.event
          templateId: query.templateId
      - text: Get the raw event log for message {messageId}.
        slots:
          messageId: query.messageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/statistics/aggregatedReport'].get
  update:
    x-apievangelist-phrasing:
      intent: Get total transactional email stats for a period
      effect: read
      questions:
      - What were my overall transactional email delivery, open and bounce totals over the last quarter?
      - Can I get one summed-up email activity figure for a single tag?
      instructions:
      - text: Give me the aggregated transactional email totals from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Sum up transactional email activity for tag {tag} over the past {days} days.
        slots:
          tag: query.tag
          days: query.days
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/log/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete transactional email logs
      effect: destructive
      questions:
      - Can I erase the transactional email logs for a person's address?
      - Is it possible to delete SMTP logs for one message ID within a date window?
      instructions:
      - text: Delete the SMTP transactional logs for {identifier}.
        slots:
          identifier: path.identifier
      - text: Delete transactional logs for {identifier} from {from_date} to {to_date}.
        slots:
          identifier: path.identifier
          from_date: query.from_date
          to_date: query.to_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List transactional email templates
      effect: read
      questions:
      - Which transactional email templates do I have in my account?
      - Can I list only the inactive email templates?
      - What is the most email templates I can fetch on one page?
      instructions:
      - text: List my email templates where active is {templateStatus}.
        slots:
          templateStatus: query.templateStatus
      - text: Show {limit} email templates, oldest first by {sort}.
        slots:
          limit: query.limit
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a transactional email template
      effect: write
      questions:
      - How do I build a new reusable transactional email template?
      - Can I create a template from an HTML URL instead of pasting the HTML?
      - Are new email templates active as soon as I create them?
      instructions:
      - text: Create email template {templateName} with subject {subject} from sender {sender}.
        slots:
          templateName: requestBody.templateName
          subject: requestBody.subject
          sender: requestBody.sender
      - text: Create active template {templateName} sent by {sender}, subject {subject}, body loaded from {htmlUrl}.
        slots:
          templateName: requestBody.templateName
          sender: requestBody.sender
          subject: requestBody.subject
          htmlUrl: requestBody.htmlUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/templates/{templateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one email template's details
      effect: read
      questions:
      - What subject, sender and HTML does a specific email template use?
      - Can I tell whether a template is a double opt-in template?
      instructions:
      - text: Show the details of email template {templateId}.
        slots:
          templateId: path.templateId
      - text: Open template {templateId} and tell me whether it is active.
        slots:
          templateId: path.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/templates/{templateId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an existing email template
      effect: write
      questions:
      - Can I change the subject line of an email template I already made?
      - How do I deactivate an email template so I can delete it later?
      instructions:
      - text: Change the subject of email template {templateId} to {subject}.
        slots:
          templateId: path.templateId
          subject: requestBody.subject
      - text: Set template {templateId} active flag to {isActive}.
        slots:
          templateId: path.templateId
          isActive: requestBody.isActive
      - text: Replace the HTML body of existing template {templateId} with {htmlContent}.
        slots:
          templateId: path.templateId
          htmlContent: requestBody.htmlContent
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/templates/{templateId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an inactive email template
      effect: destructive
      questions:
      - How do I permanently remove an email template I no longer use?
      - Why can't I delete a template that is still active?
      instructions:
      - text: Delete inactive email template {templateId}.
        slots:
          templateId: path.templateId
      - text: Permanently remove template {templateId} from my account.
        slots:
          templateId: path.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/templates/{templateId}/sendTest'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test of a transactional template
      effect: write
      questions:
      - Can I send myself a test of a transactional template before using it?
      - What happens if I leave the recipient list empty when testing a template?
      instructions:
      - text: Send a test of template {templateId} to {emailTo}.
        slots:
          templateId: path.templateId
          emailTo: requestBody.emailTo
      - text: Send template {templateId} to my test list.
        slots:
          templateId: path.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/template/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview a rendered transactional template
      effect: read
      questions:
      - What will a transactional template look like once its variables are filled in?
      - Can I render a template with a real contact's data before sending?
      instructions:
      - text: Generate a rendered preview of a transactional template.
      - text: Render the template preview with resolved variables using API key {api_key}.
        slots:
          api_key: header.api-key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/blockedContacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List blocked or unsubscribed transactional contacts
      effect: read
      questions:
      - Which contacts are blocked from receiving our transactional emails and why?
      - Can I see who unsubscribed from transactional mail during a date range?
      instructions:
      - text: List blocked transactional contacts between {startDate} and {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Show blocked or unsubscribed contacts for senders {senders}.
        slots:
          senders: query.senders
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/blockedContacts/{email}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unblock a transactional contact
      effect: destructive
      questions:
      - How do I let a blocked address receive transactional emails again?
      - Can I resubscribe someone who unsubscribed from transactional mail?
      instructions:
      - text: Unblock transactional contact {email}.
        slots:
          email: path.email
      - text: Remove {email} from the transactional blocklist so they get emails again.
        slots:
          email: path.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/blockedDomains'].get
  update:
    x-apievangelist-phrasing:
      intent: List blocked email domains
      effect: read
      questions:
      - Which recipient domains am I blocking from transactional sends?
      - Where can I see my domain blocklist?
      instructions:
      - text: List my blocked domains.
      - text: Show the domain blocklist on my account using API key {api_key}.
        slots:
          api_key: header.api-key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/blockedDomains'].post
  update:
    x-apievangelist-phrasing:
      intent: Block a recipient domain
      effect: write
      questions:
      - Can I stop all emails from going to an entire domain?
      - How do I add a domain to the blocklist?
      instructions:
      - text: Block domain {domain}.
        slots:
          domain: requestBody.domain
      - text: Add {domain} to the blocked domains list.
        slots:
          domain: requestBody.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/smtp/blockedDomains/{domain}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unblock a recipient domain
      effect: destructive
      questions:
      - How do I allow emails to a domain I blocked earlier?
      - Can I take a domain off the blocklist?
      instructions:
      - text: Unblock domain {domain}.
        slots:
          domain: path.domain
      - text: Remove {domain} from my blocked domains.
        slots:
          domain: path.domain
      method: generated
      generated: '2026-10-01'