AhaSend · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AhaSend API v2 Suppressions API

5 actions 5 updates phrasing extends openapi/ahasend-suppressions-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}/suppressions'].get
$.paths['/v2/accounts/{account_id}/suppressions'].post
$.paths['/v2/accounts/{account_id}/suppressions'].delete
$.paths['/v2/accounts/{account_id}/suppressions/all'].delete

OpenAPI Overlay

Raw ↑ 
# 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 Suppressions API
  version: 1.0.0
extends: openapi/ahasend-suppressions-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}/suppressions'].get
  update:
    x-apievangelist-phrasing:
      intent: List suppressed email addresses
      effect: read
      questions:
      - Which addresses am I currently blocked from emailing?
      - Is a particular email address on my suppression list?
      - Can I see suppressions added within a date range?
      instructions:
      - text: List suppressions on account {account_id}.
        slots:
          account_id: path.account_id
      - text: Check whether {email} is suppressed on account {account_id}.
        slots:
          email: query.email
          account_id: path.account_id
      - text: Show suppressions for domain {domain} created after {from_time} on account {account_id}.
        slots:
          domain: query.domain
          from_time: query.from_time
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/accounts/{account_id}/suppressions'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop sending to an email address
      effect: write
      questions:
      - How do I block emails to an address that asked not to be contacted?
      - Can a suppression expire automatically after a set date?
      instructions:
      - text: Suppress {email} on account {account_id} until {expires_at}.
        slots:
          email: requestBody.email
          account_id: path.account_id
          expires_at: requestBody.expires_at
      - text: Add {email} to the suppression list for domain {domain} until {expires_at} with reason {reason} on account {account_id}.
        slots:
          email: requestBody.email
          domain: requestBody.domain
          expires_at: requestBody.expires_at
          reason: requestBody.reason
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/accounts/{account_id}/suppressions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unsuppress one email address
      effect: destructive
      questions:
      - How do I allow sending to an address that was suppressed by mistake?
      - Can I lift a suppression for one address on just one domain?
      instructions:
      - text: Remove {email} from the suppression list on account {account_id}.
        slots:
          email: query.email
          account_id: path.account_id
      - text: Unsuppress {email} for domain {domain} only on account {account_id}.
        slots:
          email: query.email
          domain: query.domain
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/accounts/{account_id}/suppressions/all'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear the entire suppression list
      effect: destructive
      questions:
      - How do I wipe every suppression on my account at once?
      - Can I clear all suppressions for just one sending domain?
      instructions:
      - text: Delete all suppressions on account {account_id}.
        slots:
          account_id: path.account_id
      - text: Clear every suppression for domain {domain} on account {account_id}.
        slots:
          domain: query.domain
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'