# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for SMTP2GO SENDER DOMAINS API
  version: 1.0.0
extends: openapi/smtp2go-sender-domains-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: 7
- target: $.paths['/domain/add'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a sender domain
      effect: write
      questions:
      - How do I add my domain so I can send email from it?
      - Can I set a custom tracking and return-path subdomain when adding a domain?
      instructions:
      - text: Add sender domain {domain}.
        slots:
          domain: requestBody.domain
      - text: Add {domain} with tracking subdomain {tracking_subdomain} and return-path {returnpath_subdomain}.
        slots:
          domain: requestBody.domain
          tracking_subdomain: requestBody.tracking_subdomain
          returnpath_subdomain: requestBody.returnpath_subdomain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domain/remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a sender domain
      effect: destructive
      questions:
      - How do I delete a sender domain I no longer use?
      - Can I remove a sender domain from a subaccount?
      instructions:
      - text: Remove sender domain {domain}.
        slots:
          domain: requestBody.domain
      - text: Delete {domain} from subaccount {subaccount_id}.
        slots:
          domain: requestBody.domain
          subaccount_id: requestBody.subaccount_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domain/returnpath'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a domain's return-path subdomain
      effect: write
      questions:
      - How do I change where bounces are returned for my sender domain?
      - Can I rename the return-path subdomain on a verified domain?
      instructions:
      - text: Change the return-path subdomain of {domain} from {old_subdomain} to {new_subdomain}.
        slots:
          domain: requestBody.domain
          old_subdomain: requestBody.old_subdomain
          new_subdomain: requestBody.new_subdomain
      - text: Set the bounce return-path for {domain} to {new_subdomain}, replacing {old_subdomain}.
        slots:
          domain: requestBody.domain
          new_subdomain: requestBody.new_subdomain
          old_subdomain: requestBody.old_subdomain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domain/subaccount_access'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a sender domain with subaccounts
      effect: write
      questions:
      - Can my subaccounts send from a domain verified on the master account?
      - How do I give future subaccounts access to a sender domain automatically?
      instructions:
      - text: Let subaccounts {subaccounts} send from {domain}.
        slots:
          subaccounts: requestBody.subaccounts
          domain: requestBody.domain
      - text: Grant {subaccounts} access to {domain} and set future subaccount access to {future_subaccounts}.
        slots:
          subaccounts: requestBody.subaccounts
          domain: requestBody.domain
          future_subaccounts: requestBody.future_subaccounts
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domain/tracking'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a domain's tracking subdomain
      effect: write
      questions:
      - How do I change the subdomain used to track opens and clicks?
      - Can I rename the tracking subdomain for one sender domain?
      instructions:
      - text: Change the tracking subdomain of {domain} from {old_subdomain} to {new_subdomain}.
        slots:
          domain: requestBody.domain
          old_subdomain: requestBody.old_subdomain
          new_subdomain: requestBody.new_subdomain
      - text: Use {new_subdomain} instead of {old_subdomain} for open and click tracking on {domain}.
        slots:
          new_subdomain: requestBody.new_subdomain
          old_subdomain: requestBody.old_subdomain
          domain: requestBody.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domain/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a sender domain now
      effect: write
      questions:
      - How do I verify my sender domain without waiting for the periodic check?
      - Why isn't my domain verified yet, and can I trigger a check right away?
      instructions:
      - text: Verify sender domain {domain} now.
        slots:
          domain: requestBody.domain
      - text: Run verification on {domain} for subaccount {subaccount_id}.
        slots:
          domain: requestBody.domain
          subaccount_id: requestBody.subaccount_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domain/view'].post
  update:
    x-apievangelist-phrasing:
      intent: List sender domains
      effect: read
      questions:
      - Which sender domains are on my account and are they verified?
      - Can I see the DNS status of one sender domain?
      instructions:
      - text: List my sender domains.
      - text: Show the details of sender domain {domain}.
        slots:
          domain: requestBody.domain
      method: generated
      generated: '2026-10-01'