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.
# 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 Franchisee API
version: 1.0.0
extends: openapi/punchh-franchisee-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: 3
- target: $.paths['/api2/dashboard/franchisees'].post
update:
x-apievangelist-phrasing:
intent: Create a franchisee for locations
effect: write
questions:
- How does a business admin set up a new franchisee for their locations?
- Can I create franchisees only for locations I can access?
instructions:
- text: Create franchisee {franchisee}.
slots:
franchisee: requestBody.franchisee
- text: 'Add a new franchisee with these details: {franchisee}.'
slots:
franchisee: requestBody.franchisee
method: generated
generated: '2026-10-01'
- target: $.paths['/api2/dashboard/franchisees'].delete
update:
x-apievangelist-phrasing:
intent: Delete a franchisee
effect: destructive
questions:
- How do I remove a franchisee that no longer operates our stores?
- Which franchisees can a business admin delete?
instructions:
- text: Delete franchisee {id}.
slots:
id: requestBody.id
- text: Remove franchisee {id} from our accessible locations.
slots:
id: requestBody.id
method: generated
generated: '2026-10-01'
- target: $.paths['/api2/dashboard/franchisees'].patch
update:
x-apievangelist-phrasing:
intent: Update a franchisee's details
effect: write
questions:
- Can I change the details of an existing franchisee?
- What's needed to update a franchisee record?
instructions:
- text: Update franchisee {id} with {franchisee}.
slots:
id: requestBody.id
franchisee: requestBody.franchisee
- text: Edit franchisee {id}.
slots:
id: requestBody.id
method: generated
generated: '2026-10-01'
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.