Punchh · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Platform Functions E Club API

2 actions 2 updates phrasing extends openapi/punchh-eclub-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/api2/dashboard/eclub_guests'].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 Platform Functions E Club API
  version: 1.0.0
extends: openapi/punchh-eclub-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['/api2/dashboard/eclub_guests'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload or update eClub guests
      effect: write
      questions:
      - How do I bulk add email club guests collected at a store?
      - Can the eClub upload also update existing guests' details?
      instructions:
      - text: Upload eClub guests {user} for store {store_number}.
        slots:
          user: requestBody.user
          store_number: requestBody.store_number
      - text: Add eClub sign-ups from source {source} at store {store_number}.
        slots:
          source: requestBody.source
          store_number: requestBody.store_number
      method: generated
      generated: '2026-10-01'