Act-On · OpenAPI Overlay 1.0.0

API Evangelist enrichment overlay — Act-On REST API (act-on-api-1) — /api/1, /ucl/v2 and /ete/v1

6 actions 6 updates update extends openapi/act-on-rest-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Act-On's API. It is a proposal applied on top of the contract, not a document Act-On publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelistcontacttermsOfServicex-rate-limitsx-idempotencyx-artifactsx-observations

Targets 2

$.info
$.servers

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enrichment overlay — Act-On REST API (act-on-api-1) — /api/1, /ucl/v2 and /ete/v1
  version: 1.0.0
extends: openapi/act-on-rest-api-openapi.yml
x-provenance:
  generated: '2026-08-13'
  method: generated
  source: openapi/act-on-rest-api-openapi.yml + https://developer.act-on.com/reference/api-overview
  note: Additive only. Nothing in the published Act-On contract is removed or rewritten; the verbatim
    harvest lives in openapi/_original/.
actions:
- target: $.info
  description: Record who enriched this document and where the original came from. The source specs are
    published by Act-On through its ReadMe developer portal and were harvested verbatim to openapi/_original/.
  update:
    x-apievangelist:
      enriched: '2026-08-13'
      pass: local-v1
      harvested-from: https://developer.act-on.com/reference/ (ReadMe-embedded OpenAPI)
      original: openapi/_original/
    contact:
      name: Act-On Developer Support
      url: https://developer.act-on.com/reference/request-a-developer-account
    termsOfService: https://act-on.com/terms-of-service/
- target: $.info
  description: Act-On's published account-wide API limits (API Overview). They are prose on the docs page
    and appear nowhere in the contract.
  update:
    x-rate-limits:
      requests-per-second: 5
      requests-per-day: 30000
      auth-calls-per-hour: 5
      max-upload-mb: 400
      source: https://developer.act-on.com/reference/api-overview
      response-headers: none — no RateLimit-*, X-RateLimit-* or Retry-After is returned
      status-on-exhaustion: not documented; no 429 declared on any operation
- target: $.info
  description: Act-On documents no idempotency mechanism. Recorded explicitly because several operations
    (message send, transactional email) are irreversible and externally visible.
  update:
    x-idempotency:
      supported: false
      header: null
      note: No Idempotency-Key on any published operation. A retried send is a second send.
- target: $.info
  description: Cross-links to the derived artifacts in this repo that carry semantics the contract does
    not.
  update:
    x-artifacts:
      conventions: conventions/act-on-conventions.yml
      errors: errors/act-on-problem-types.yml
      lifecycle: lifecycle/act-on-lifecycle.yml
      authentication: authentication/act-on-authentication.yml
      rate-limits: rate-limits/act-on-rate-limits.yml
      data-model: data-model/act-on-data-model.yml
      webhooks: asyncapi/act-on-webhooks.yml
- target: $.servers
  description: Act-On's API Overview instructs European customers to change the base URL to api-eu.actonsoftware.com.
    The published servers[] block names only the US host.
  update:
  - url: https://api-eu.actonsoftware.com
    description: EU region — per https://developer.act-on.com/reference/api-overview
- target: $.info
  description: Observations from reading the contract, recorded as annotation rather than mutation.
  update:
    x-observations:
      named-schemas: 0
      note: This document declares zero reusable component schemas across 125 operations; every request
        and response body is inlined and many response schemas are an empty object with the real shape
        shown only in an example string.
      generations-served:
      - /api/1 (legacy, form-encoded)
      - /ucl/v2 (Act-On Contacts, JSON)
      - /ete/v1 (transactional email)
      pagination: offset+count on /api/1, page+pageSize on /ucl/v2 — incompatible within one document