Mailchimp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mailchimp Transactional Users API

5 actions 5 updates phrasing extends openapi/mailchimp-users-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Mailchimp's API. It is a proposal applied on top of the contract, not a document Mailchimp publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/users/info'].post
$.paths['/users/ping'].post
$.paths['/users/ping2'].post
$.paths['/users/senders'].post

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 Mailchimp Transactional Users API
  version: 1.0.0
extends: openapi/mailchimp-users-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['/users/info'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the API-connected user's account info
      effect: read
      questions:
      - Which transactional account and reputation is my API key tied to?
      - Can I see my account's hourly quota and backlog through the API?
      instructions:
      - text: Show the account info for API key {key}.
        slots:
          key: requestBody.key
      - text: Get my transactional account's reputation and hourly quota.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/ping'].post
  update:
    x-apievangelist-phrasing:
      intent: Check that an API key works
      effect: read
      questions:
      - Is my transactional API key valid?
      - What's the quickest way to test connectivity to the transactional API?
      instructions:
      - text: Ping the transactional API with key {key}.
        slots:
          key: requestBody.key
      - text: Verify that API key {key} is accepted.
        slots:
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/ping2'].post
  update:
    x-apievangelist-phrasing:
      intent: Check an API key with a JSON ping response
      effect: read
      questions:
      - Can I validate my API key and get the ping answer back as JSON?
      - Is there a ping variant that returns a JSON object instead of plain text?
      instructions:
      - text: Run the JSON-parser ping (ping2) with key {key}.
        slots:
          key: requestBody.key
      - text: Validate key {key} using the JSON ping2 check.
        slots:
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/senders'].post
  update:
    x-apievangelist-phrasing:
      intent: List senders that have used the account
      effect: read
      questions:
      - Which from addresses have tried to send through my transactional account?
      - Can I see both verified and unverified senders on my account?
      instructions:
      - text: List all senders that have used API key {key}.
        slots:
          key: requestBody.key
      - text: Show my account's verified and unverified sender addresses.
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/mailchimp-users-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.