AhaSend · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AhaSend API v2 Accounts API

6 actions 6 updates phrasing extends openapi/ahasend-accounts-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}'].get

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

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

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

$.paths['/v2/accounts/{account_id}/members/{user_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 Accounts API
  version: 1.0.0
extends: openapi/ahasend-accounts-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}'].get
  update:
    x-apievangelist-phrasing:
      intent: View account details
      effect: read
      questions:
      - What settings and details are stored on my AhaSend account?
      - Can I see my account's current open and click tracking defaults?
      instructions:
      - text: Show me the details of account {account_id}.
        slots:
          account_id: path.account_id
      - text: Fetch the current settings for my email sending account {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/accounts/{account_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change account settings
      effect: write
      questions:
      - How do I turn on click tracking by default for my whole account?
      - Can I shorten how many days message data is retained on my account?
      - Is there a way to reject mistyped recipient addresses account-wide?
      instructions:
      - text: Rename account {account_id} to {name}.
        slots:
          account_id: path.account_id
          name: requestBody.name
      - text: Set the account website for {account_id} to {website}.
        slots:
          account_id: path.account_id
          website: requestBody.website
      - text: Keep message metadata for {message_metadata_retention} days on account {account_id}.
        slots:
          account_id: path.account_id
          message_metadata_retention: requestBody.message_metadata_retention
      - text: Enable default open tracking on account {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/accounts/{account_id}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List account team members
      effect: read
      questions:
      - Who has access to my email sending account?
      - Which users are members of our account and what roles do they have?
      instructions:
      - text: List all members of account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show me the team members who can log in to account {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/accounts/{account_id}/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a user to the account
      effect: write
      questions:
      - How do I give a colleague access to our account?
      - What roles can I assign when adding a new team member?
      instructions:
      - text: Add {email} to account {account_id} as a {role}.
        slots:
          email: requestBody.email
          account_id: path.account_id
          role: requestBody.role
      - text: Invite {name} at {email} to account {account_id} with the {role} role.
        slots:
          name: requestBody.name
          email: requestBody.email
          account_id: path.account_id
          role: requestBody.role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/accounts/{account_id}/members/{user_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from the account
      effect: destructive
      questions:
      - How do I revoke a former employee's access to our account?
      - Can I remove the account owner or myself from the team?
      instructions:
      - text: Remove user {user_id} from account {account_id}.
        slots:
          user_id: path.user_id
          account_id: path.account_id
      - text: Take member {user_id} off the team for account {account_id}.
        slots:
          user_id: path.user_id
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'