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 REST Account API
version: 1.0.0
extends: openapi/impact-account-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: 2
- target: $.paths['/{tenant_alias}/accountsync'].post
update:
x-apievangelist-phrasing:
intent: Create or update a referral account
effect: write
questions:
- How do I tell impact.com that an account's subscription status changed?
- Is the account sync call available on newer programs or only classic ones?
instructions:
- text: In tenant {tenant}, sync account {id} with subscription {subscription}.
slots:
tenant: path.tenant_alias
id: requestBody.id
subscription: requestBody.subscription
- text: Create or update account {id} in tenant {tenant} with subscription {subscription} and currency {currency}.
slots:
tenant: path.tenant_alias
id: requestBody.id
subscription: requestBody.subscription
currency: requestBody.currency
method: generated
generated: '2026-09-26'
- target: $.paths['/{tenant_alias}/account/{accountId}'].get
update:
x-apievangelist-phrasing:
intent: Look up a referral account
effect: read
questions:
- What information is stored for one referral account?
- Can I fetch an account by its ID on a classic program?
instructions:
- text: Look up account {acct} in tenant {tenant}.
slots:
tenant: path.tenant_alias
acct: path.accountId
- text: Show stored details for account {acct}, tenant {tenant}.
slots:
tenant: path.tenant_alias
acct: path.accountId
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.