# 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'