AhaSend · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AhaSend API v2 SMTP Credentials API

5 actions 5 updates phrasing extends openapi/ahasend-smtp-credentials-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for AhaSend's API. It is a proposal applied on top of the contract, not a document AhaSend publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/v2/accounts/{account_id}/smtp-credentials'].get

$.paths['/v2/accounts/{account_id}/smtp-credentials'].post

$.paths['/v2/accounts/{account_id}/smtp-credentials/{smtp_credential_id}'].get

$.paths['/v2/accounts/{account_id}/smtp-credentials/{smtp_credential_id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for AhaSend API v2 SMTP Credentials API
  version: 1.0.0
extends: openapi/ahasend-smtp-credentials-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: 4
- target: $.paths['/v2/accounts/{account_id}/smtp-credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List SMTP credentials
      effect: read
      questions:
      - Which SMTP usernames have been created for my account?
      - Can I see all the SMTP credentials my apps use to relay mail?
      instructions:
      - text: List SMTP credentials on account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show up to {limit} SMTP logins for account {account_id}.
        slots:
          limit: query.limit
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/accounts/{account_id}/smtp-credentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an SMTP login
      effect: write
      questions:
      - How do I get SMTP credentials so my app can send over SMTP?
      - Can I create an SMTP credential that only works for certain domains?
      - Is there a sandbox SMTP credential option for testing?
      instructions:
      - text: Create a global SMTP credential named {name} on account {account_id}.
        slots:
          name: requestBody.name
          account_id: path.account_id
      - text: Create SMTP credential {name} with scope {scope} for domains {domains} in account {account_id}.
        slots:
          name: requestBody.name
          scope: requestBody.scope
          domains: requestBody.domains
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/accounts/{account_id}/smtp-credentials/{smtp_credential_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one SMTP credential
      effect: read
      questions:
      - Which domains is a particular SMTP credential tied to?
      - Is a specific SMTP credential a sandbox one?
      instructions:
      - text: Show SMTP credential {smtp_credential_id} on account {account_id}.
        slots:
          smtp_credential_id: path.smtp_credential_id
          account_id: path.account_id
      - text: Get the scope and domains of SMTP login {smtp_credential_id} in account {account_id}.
        slots:
          smtp_credential_id: path.smtp_credential_id
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/accounts/{account_id}/smtp-credentials/{smtp_credential_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an SMTP credential
      effect: destructive
      questions:
      - How do I revoke SMTP access for an app we retired?
      - Can I delete an SMTP login that's no longer needed?
      instructions:
      - text: Delete SMTP credential {smtp_credential_id} from account {account_id}.
        slots:
          smtp_credential_id: path.smtp_credential_id
          account_id: path.account_id
      - text: Revoke SMTP login {smtp_credential_id} on account {account_id}.
        slots:
          smtp_credential_id: path.smtp_credential_id
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'