Generated by API Evangelist
Written by API Evangelist tooling for Impact's API. It is a proposal applied on top of the contract, not a document Impact publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for impact.com Referral Code API
version: 1.0.0
extends: openapi/impact-referral-code-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: 3
- target: $.paths['/{tenant_alias}/code/{code}'].get
update:
x-apievangelist-phrasing:
intent: Look up a referral code (deprecated)
effect: read
questions:
- Is the older referral code lookup still supported?
- What does the deprecated code lookup return about the referrer?
instructions:
- text: Use the deprecated lookup for referral code {code} in tenant {tenant}.
slots:
tenant: path.tenant_alias
code: path.code
- text: Look up code {code} with the legacy authenticated endpoint.
slots:
code: path.code
method: generated
generated: '2026-09-26'
- target: $.paths['/{tenant_alias}/open/code/{referral_code}'].get
update:
x-apievangelist-phrasing:
intent: Validate a referral code from the client
effect: read
questions:
- How do I check a referral code from my mobile or web app?
- Can I show who referred someone and what reward the code gives?
instructions:
- text: Validate referral code {code} for tenant {tenant} via the open endpoint.
slots:
tenant: path.tenant_alias
code: path.referral_code
- text: Show the referrer name and reward for code {code} client-side.
slots:
code: path.referral_code
method: generated
generated: '2026-09-26'
- target: $.paths['/{tenant_alias}/open/code/{code}/account/{accountId}/user/{userId}'].post
update:
x-apievangelist-phrasing:
intent: Apply a referral code to a user
effect: write
questions:
- How do I mark a new user as referred by someone's code?
- Does applying a referral code need a write token?
instructions:
- text: Apply code {code} to user {user} on account {account} in tenant {tenant}.
slots:
tenant: path.tenant_alias
code: path.code
account: path.accountId
user: path.userId
- text: Credit referral code {code} for new user {user} of account {account}.
slots:
code: path.code
account: path.accountId
user: path.userId
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.