AhaSend · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AhaSend API v2 Routes API

6 actions 6 updates phrasing extends openapi/ahasend-routes-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 6

$.info

$.paths['/v2/accounts/{account_id}/routes'].get

$.paths['/v2/accounts/{account_id}/routes'].post

$.paths['/v2/accounts/{account_id}/routes/{route_id}'].get

$.paths['/v2/accounts/{account_id}/routes/{route_id}'].put

$.paths['/v2/accounts/{account_id}/routes/{route_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 Routes API
  version: 1.0.0
extends: openapi/ahasend-routes-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['/v2/accounts/{account_id}/routes'].get
  update:
    x-apievangelist-phrasing:
      intent: List inbound email routes
      effect: read
      questions:
      - Which inbound email routes are set up on my account?
      - Can I list only the routes for one receiving domain?
      instructions:
      - text: List all inbound routes on account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show routes for domain {domain} on account {account_id}.
        slots:
          domain: query.domain
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/accounts/{account_id}/routes'].post
  update:
    x-apievangelist-phrasing:
      intent: Route inbound email to a webhook
      effect: write
      questions:
      - How do I forward incoming email for an address to my own webhook?
      - Can inbound emails be posted to my URL with attachments included?
      instructions:
      - text: Create a route named {name} that sends mail for {recipient} to {url} on account {account_id}.
        slots:
          name: requestBody.name
          recipient: requestBody.recipient
          url: requestBody.url
          account_id: path.account_id
      - text: Set up inbound routing for {recipient} to post to {url}, stripping replies, in account {account_id}.
        slots:
          recipient: requestBody.recipient
          url: requestBody.url
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/accounts/{account_id}/routes/{route_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one inbound route
      effect: read
      questions:
      - Where does a particular inbound route send its email?
      - Can I check whether one specific route is enabled?
      instructions:
      - text: Show route {route_id} on account {account_id}.
        slots:
          route_id: path.route_id
          account_id: path.account_id
      - text: Get the webhook URL and recipient filter for route {route_id} in account {account_id}.
        slots:
          route_id: path.route_id
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/accounts/{account_id}/routes/{route_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an existing inbound route
      effect: write
      questions:
      - How do I point an existing inbound route at a new webhook URL?
      - Can I temporarily disable a route without deleting it?
      instructions:
      - text: Change the URL of route {route_id} to {url} on account {account_id}.
        slots:
          route_id: path.route_id
          url: requestBody.url
          account_id: path.account_id
      - text: Set enabled to {enabled} on existing route {route_id} in account {account_id}.
        slots:
          enabled: requestBody.enabled
          route_id: path.route_id
          account_id: path.account_id
      - text: Update route {route_id} on account {account_id} to match recipient {recipient}.
        slots:
          route_id: path.route_id
          account_id: path.account_id
          recipient: requestBody.recipient
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/accounts/{account_id}/routes/{route_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an inbound route
      effect: destructive
      questions:
      - How do I stop receiving inbound email at my webhook for good?
      - What's needed to permanently remove an inbound route?
      instructions:
      - text: Delete route {route_id} from account {account_id}.
        slots:
          route_id: path.route_id
          account_id: path.account_id
      - text: Remove inbound route {route_id} in account {account_id}.
        slots:
          route_id: path.route_id
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'