Stannp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stannp Direct Mail Events API

2 actions 2 updates phrasing extends openapi/stannp-events-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Stannp's API. It is a proposal applied on top of the contract, not a document Stannp publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/recipientEvents/create'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stannp Direct Mail Events API
  version: 1.0.0
extends: openapi/stannp-events-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: 1
- target: $.paths['/recipientEvents/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an engagement event for a recipient
      effect: write
      questions:
      - How do I log that a mail recipient made a purchase after receiving a mailpiece?
      - Can a signup or page view from a recipient trigger a follow-up mail automation?
      - Is it possible to mark a recipient's event as a conversion and tie it to a specific campaign?
      instructions:
      - text: Record a {name} event for recipient {recipient_id}.
        slots:
          name: requestBody.name
          recipient_id: requestBody.recipient_id
      - text: Log a PURCHASE conversion worth {value} for recipient {recipient_id}.
        slots:
          value: requestBody.value
          recipient_id: requestBody.recipient_id
      - text: Attribute a {name} event from recipient {recipient_id} to mailing {ref}.
        slots:
          name: requestBody.name
          recipient_id: requestBody.recipient_id
          ref: requestBody.ref
      method: generated
      generated: '2026-09-26'