AhaSend · OpenAPI Overlay 1.0.0

API Evangelist enhancements for AhaSend API v2 Accounts Suppressions API

6 actions 6 updates update extends 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-reversibilitytermsOfServicecontactexternalDocsx-rate-limitsx-error-envelopex-paginationx-idempotency

Targets 4

$.info
$
$.paths['/v2/accounts/{account_id}/suppressions'].post
$.paths['/v2/accounts/{account_id}/suppressions/all'].delete

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements for AhaSend API v2 Accounts Suppressions API
  version: 1.0.0
extends: ahasend-suppressions-api-openapi.yml
x-provenance:
  generated: '2026-08-30'
  method: generated
  source: Facts published by AhaSend at ahasend.com/docs; see conventions/, errors/, rate-limits/ and conventions/
    reversibility.
  note: This overlay is authored by API Evangelist, not by AhaSend. It never mutates the original contract.
actions:
- target: $.info
  description: Add the published legal, support and documentation URLs the source contract omits.
  update:
    termsOfService: https://ahasend.com/terms
    contact:
      name: AhaSend Support
      email: support@ahasend.com
      url: https://ahasend.com/contact
- target: $
  description: Point the contract at its own reference documentation.
  update:
    externalDocs:
      description: AhaSend API reference
      url: https://ahasend.com/docs/api-reference/suppressions/create-suppression
- target: $
  description: Record the published account-level rate limits and the error envelope contract, neither of which
    the source spec declares.
  update:
    x-rate-limits:
      scope: account
      algorithm: sliding window, 1 second
      requests_per_second: 100
      burst: 200
      status_on_exhaustion: 429
      response_headers: []
      documentation: https://ahasend.com/docs/api-reference/rate-limits
    x-error-envelope:
      format: bare-json
      shape: '{"message": "string"}'
      rfc9457: false
      stable_machine_code: false
      note: Branch on HTTP status only. The contract states clients must not parse message to distinguish errors
        sharing a status.
      catalog: errors/ahasend-problem-types.yml
    x-pagination:
      style: cursor
      params:
      - limit
      - after
      - before
      response: pagination.has_more / next_cursor / previous_cursor
- target: $
  description: Declare idempotency support, which the source contract implies through a response header but never
    states.
  update:
    x-idempotency:
      header: Idempotency-Key
      methods:
      - POST
      scope: account
      retention: 24 hours (5 minutes for secret-bearing API key creation)
      replay_signal_header: Idempotent-Replayed
      operations:
      - createSuppression
      documentation: https://ahasend.com/docs/api-reference/idempotency
- target: $.paths['/v2/accounts/{account_id}/suppressions'].post
  description: Record the published reversal path for createSuppression.
  update:
    x-reversibility:
      reversible: true
      reversal_operation: deleteSuppression
      window: no stated time limit
      source: conventions/ahasend-conventions.yml
- target: $.paths['/v2/accounts/{account_id}/suppressions/all'].delete
  description: Flag deleteAllSuppressions as an irreversible write for agent gating.
  update:
    x-reversibility:
      reversible: false
      reversal_operation: null
      note: 'Irreversible and account-wide: wipes the bounce and complaint history that protects sender reputation.'