SMTP2GO · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SMTP2GO ACTIVITY API

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

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/activity/search'].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 SMTP2GO ACTIVITY API
  version: 1.0.0
extends: openapi/smtp2go-activity-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/activity/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search email activity events
      effect: read
      questions:
      - Which recipients opened or unsubscribed from my emails this week?
      - Can I find every delivery event for one specific email ID?
      - What happens when more than 1,000 events match my activity filter?
      instructions:
      - text: Search activity events for emails sent to {search_recipient}.
        slots:
          search_recipient: requestBody.search_recipient
      - text: Find all events for email {search_email_id}.
        slots:
          search_email_id: requestBody.search_email_id
      - text: Show only {event_types} events between {start_date} and {end_date}.
        slots:
          event_types: requestBody.event_types
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Search activity for emails whose subject contains {search_subject}.
        slots:
          search_subject: requestBody.search_subject
      method: generated
      generated: '2026-10-01'