Generated by API Evangelist
Written by API Evangelist tooling for Thanx's API. It is a proposal applied on top of the contract, not a document Thanx publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Thanx Partner Campaigns API
version: 1.0.0
extends: openapi/thanx-campaigns-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 4
- target: $.paths['/partner/campaigns'].get
update:
x-apievangelist-phrasing:
intent: List a merchant's campaigns
effect: read
questions:
- Which marketing campaigns are set up for my merchant?
- Can I see all the loyalty campaigns running for a specific brand?
instructions:
- text: List all campaigns for merchant {merchant_id}.
slots:
merchant_id: query.merchant_id
- text: Show me every campaign I have access to.
method: generated
generated: '2026-09-26'
- target: $.paths['/partner/campaigns'].post
update:
x-apievangelist-phrasing:
intent: Create a marketing campaign
effect: write
questions:
- How do I set up a new marketing campaign with a control group?
- Can I create a campaign that tests a treatment variant against a control?
instructions:
- text: Create a new campaign with {campaign}.
slots:
campaign: requestBody.campaign
- text: Set up a campaign with treatment and control variants using {campaign}.
slots:
campaign: requestBody.campaign
method: generated
generated: '2026-09-26'
- target: $.paths['/partner/campaigns/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get one campaign's details
effect: read
questions:
- What are the variants and settings of a particular campaign?
- How do I look up a single campaign by its ID in Thanx?
instructions:
- text: Get the details of campaign {id}.
slots:
id: path.id
- text: Show me the variants for campaign {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/partner/campaigns/issue'].post
update:
x-apievangelist-phrasing:
intent: Issue campaign rewards to a batch of users
effect: write
questions:
- How do I send campaign rewards to a list of customers at once?
- How many identifiers can I include in one reward issuance request?
- Does issuing campaign rewards happen immediately or as a background job?
instructions:
- text: Issue rewards from campaign {campaign_id} variant {variant_id} to {identifiers} for merchant {merchant_id}.
slots:
campaign_id: requestBody.campaign_id
variant_id: requestBody.variant_id
identifiers: requestBody.identifiers
merchant_id: requestBody.merchant_id
- text: Give these customers {identifiers} the reward for campaign {campaign_id}, variant {variant_id}, merchant {merchant_id}.
slots:
identifiers: requestBody.identifiers
campaign_id: requestBody.campaign_id
variant_id: requestBody.variant_id
merchant_id: requestBody.merchant_id
method: generated
generated: '2026-09-26'
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.