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 Mobile Social Cause Campaign API
version: 1.0.0
extends: openapi/punchh-social-cause-campaign-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/mobile/social_causes'].get
update:
x-apievangelist-phrasing:
intent: Search active charity campaigns
effect: read
questions:
- Which charities can guests donate to through the loyalty app?
- Can I search social cause campaigns by city or zip code?
instructions:
- text: Search charity campaigns for {query}, page {page}, {per_page} per page.
slots:
query: requestBody.query
page: requestBody.page
per_page: requestBody.per_page
- text: Find social causes matching {query} on page {page} with {per_page} results.
slots:
query: requestBody.query
page: requestBody.page
per_page: requestBody.per_page
method: generated
generated: '2026-10-01'
- target: $.paths['/api2/mobile/social_causes'].post
update:
x-apievangelist-phrasing:
intent: Donate to a social cause campaign
effect: write
questions:
- How does a guest donate points or money to a charity campaign?
- What kinds of items can a guest donate to a social cause?
instructions:
- text: Donate {item_to_donate} as {donation_type} to social cause {social_cause_id}.
slots:
item_to_donate: requestBody.item_to_donate
donation_type: requestBody.donation_type
social_cause_id: requestBody.social_cause_id
- text: Give {item_to_donate} of type {donation_type} to charity campaign {social_cause_id}.
slots:
item_to_donate: requestBody.item_to_donate
donation_type: requestBody.donation_type
social_cause_id: requestBody.social_cause_id
method: generated
generated: '2026-10-01'
- target: $.paths['/api2/mobile/social_causes/{social_cause_id}'].get
update:
x-apievangelist-phrasing:
intent: View a guest's donations to a cause
effect: read
questions:
- How much has this guest donated to a particular charity campaign?
- Can I see campaign details for one social cause?
instructions:
- text: Show donation details for social cause {social_cause_id}.
slots:
social_cause_id: path.social_cause_id
- text: What have I given to cause {social_cause_id}? Show me.
slots:
social_cause_id: path.social_cause_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.