# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Accounts and Settings Domains API
  version: 1.0.0
extends: openapi/brevo-domains-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: 5
- target: $.paths['/senders/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List sender domains
      effect: read
      questions:
      - Which sending domains have I added to Brevo?
      - Are all my sender domains authenticated and verified?
      instructions:
      - text: List all my sender domains.
      - text: Show every sender domain and its verification status using API key {api_key}.
        slots:
          api_key: header.api-key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/senders/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a sender domain
      effect: write
      questions:
      - How do I add my company domain for sending emails?
      - What DNS records do I get back after adding a new sending domain?
      instructions:
      - text: Add sender domain {name}.
        slots:
          name: requestBody.name
      - text: Create domain {name} so I can send email from it.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/senders/domains/{domainName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a sender domain's configuration
      effect: read
      questions:
      - Is my sending domain configured correctly?
      - Which DNS records for a domain are still missing?
      instructions:
      - text: Get the configuration of domain {domainName}.
        slots:
          domainName: path.domainName
      - text: Check whether {domainName} is set up correctly for sending.
        slots:
          domainName: path.domainName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/senders/domains/{domainName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sender domain
      effect: destructive
      questions:
      - How do I remove a test domain from my sending setup?
      - Can I delete a sender domain I no longer use?
      instructions:
      - text: Delete sender domain {domainName}.
        slots:
          domainName: path.domainName
      - text: Remove the domain {domainName} from my account.
        slots:
          domainName: path.domainName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/senders/domains/{domainName}/authenticate'].put
  update:
    x-apievangelist-phrasing:
      intent: Authenticate a sender domain
      effect: write
      questions:
      - I've added the DNS records, how do I get the domain authenticated?
      - Can I trigger domain authentication after updating DKIM?
      instructions:
      - text: Authenticate domain {domainName}.
        slots:
          domainName: path.domainName
      - text: Verify the DNS records for {domainName} and complete authentication.
        slots:
          domainName: path.domainName
      method: generated
      generated: '2026-09-26'