Punchh · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mobile Coupons API

2 actions 2 updates phrasing extends openapi/punchh-coupons-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/mobile/coupons'].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 Mobile Coupons API
  version: 1.0.0
extends: openapi/punchh-coupons-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/mobile/coupons'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a coupon or promo code
      effect: write
      questions:
      - How does a guest enter a promo code in the app to get a reward?
      - Where can a guest see the reward after applying a coupon?
      instructions:
      - text: Apply coupon code {code}.
        slots:
          code: requestBody.code
      - text: Redeem promo code {code} for my account.
        slots:
          code: requestBody.code
      method: generated
      generated: '2026-10-01'