# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for SMTP2GO SMTP USERS API
  version: 1.0.0
extends: openapi/smtp2go-smtp-users-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: 5
- target: $.paths['/users/smtp/add'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an SMTP user
      effect: write
      questions:
      - How do I create new SMTP credentials for an application?
      - Can a new SMTP user get its own rate limit and password?
      instructions:
      - text: Create SMTP user {username}.
        slots:
          username: requestBody.username
      - text: Add SMTP user {username} with password {email_password}.
        slots:
          username: requestBody.username
          email_password: requestBody.email_password
      - text: Create SMTP user {username} on subaccount {subaccount_id}.
        slots:
          username: requestBody.username
          subaccount_id: requestBody.subaccount_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/smtp/edit'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace an SMTP user's settings
      effect: write
      questions:
      - How do I do a full update of an SMTP user's settings?
      - Can I change an SMTP user's password with a full edit?
      instructions:
      - text: Edit SMTP user {username} and set the password to {email_password}.
        slots:
          username: requestBody.username
          email_password: requestBody.email_password
      - text: Fully update SMTP user {username} with description {description}.
        slots:
          username: requestBody.username
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/smtp/edit'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update an SMTP user
      effect: write
      questions:
      - Can I change only one field on an SMTP user and leave the rest alone?
      - What's the way to just switch off click tracking for one SMTP user?
      instructions:
      - text: Patch SMTP user {username}, setting only status to {status}.
        slots:
          username: requestBody.username
          status: requestBody.status
      - text: Patch just the click tracking on SMTP user {username} to {click_tracking_enabled}.
        slots:
          username: requestBody.username
          click_tracking_enabled: requestBody.click_tracking_enabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/smtp/remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an SMTP user
      effect: destructive
      questions:
      - How do I delete SMTP credentials that are no longer used?
      - Can I remove an SMTP user from a subaccount?
      instructions:
      - text: Remove SMTP user {username}.
        slots:
          username: requestBody.username
      - text: Delete SMTP user {username} from subaccount {subaccount_id}.
        slots:
          username: requestBody.username
          subaccount_id: requestBody.subaccount_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/smtp/view'].post
  update:
    x-apievangelist-phrasing:
      intent: List SMTP users
      effect: read
      questions:
      - Which SMTP users exist on my account?
      - Can I look up the settings of one SMTP username?
      instructions:
      - text: List all SMTP users.
      - text: Show details for SMTP user {username}.
        slots:
          username: requestBody.username
      method: generated
      generated: '2026-10-01'