Punchh · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mobile Beacons API

3 actions 3 updates phrasing extends openapi/punchh-beacons-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 3

$.info

$.paths['/api2/mobile/locations/beacon_entry'].post

$.paths['/api2/mobile/locations/beacon_exit'].delete

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 Mobile Beacons API
  version: 1.0.0
extends: openapi/punchh-beacons-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: 2
- target: $.paths['/api2/mobile/locations/beacon_entry'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a guest entering a beacon's range
      effect: write
      questions:
      - What happens when a loyalty member walks into range of a store beacon?
      - Which beacon identifiers does the app send on entry?
      instructions:
      - text: Record a beacon entry for beacon {beacon_major}/{beacon_minor}.
        slots:
          beacon_major: requestBody.beacon_major
          beacon_minor: requestBody.beacon_minor
      - text: Log that the guest arrived near beacon minor {beacon_minor}.
        slots:
          beacon_minor: requestBody.beacon_minor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api2/mobile/locations/beacon_exit'].delete
  update:
    x-apievangelist-phrasing:
      intent: Record a guest leaving a beacon's range
      effect: destructive
      questions:
      - What gets triggered when a guest leaves a store beacon's range?
      - How does the app report that a detected guest walked away from a beacon?
      instructions:
      - text: Record a beacon exit for beacon {beacon_major}/{beacon_minor}.
        slots:
          beacon_major: requestBody.beacon_major
          beacon_minor: requestBody.beacon_minor
      - text: Log that the guest left the range of beacon minor {beacon_minor}.
        slots:
          beacon_minor: requestBody.beacon_minor
      method: generated
      generated: '2026-10-01'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This overlay

curl "https://apis.io/api/v1/overlays/punchh-beacons-api-phrasing-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.