Impact

Impact User API

API for managing users, including creation, lookup, and blocking.

Documentation GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /{tenant_alias}/user Create or update a referral program user · Create or Update a User #

Ask an LLM

“How do I add a participant to my referral program or update their details?”

“Does upserting a user also create the account it points to?”

Tell an agent

In tenant {tenant}, upsert user {id} on existing account {acct} with email {email}.

Save user {id} on account {acct} in tenant {tenant} with referral code {code}.

GET /{tenant_alias}/user Look up a user by referral code · Lookup a user by Referral Code #

Ask an LLM

“Who does this referral code belong to in my referral program?”

“Can I retrieve a user's details when all I have is their referral code?”

Tell an agent

In tenant {tenant}, look up the user with referral code {code} using my API key.

Find the referral participant for code {code} in tenant {tenant}.

GET /{tenant_alias}/account/{accountId}/user/{userId} Look up a user by ID · Lookup a user #

Ask an LLM

“What personal details are stored for a referral user, looked up by their ID?”

“Does the user lookup include rewards or referrals, or only the user's own info?”

Tell an agent

In tenant {tenant}, get user {user} on account {acct}.

Show the profile of user {user} in account {acct}, tenant {tenant}.

GET /{tenant_alias}/account/{accountId}/user/{userId}/pii Get the personal data stored for a user · Lookup a user PII #

Ask an LLM

“What personally identifiable information does impact.com hold about one of my users?”

“Can I export a user's PII to answer a data privacy request?”

Tell an agent

In tenant {tenant}, pull the PII stored for user {user} on account {acct}.

For a privacy request, get user {user}'s personal data on account {acct} in tenant {tenant}.

POST /{tenant_alias}/account/{accountId}/user/{userId}/block Block a user from making referrals · Block user #

Ask an LLM

“Can I stop a suspicious user from earning successful referrals?”

“What happens to a participant's referrals once they are blocked?”

Tell an agent

Block user {user} on account {acct} in tenant {tenant} from referring.

Stop user {user} in account {acct}, tenant {tenant}, from making successful referrals.

POST /{tenant_alias}/account/{accountId}/user/{userId}/unblock Unblock a user so they can refer again · Unblock user #

Ask an LLM

“How can I lift a block on a referral participant?”

“Can a previously blocked user be allowed to refer again?”

Tell an agent

Unblock user {user} on account {acct} in tenant {tenant}.

Restore referral privileges for user {user} in account {acct}, tenant {tenant}.

GET /{tenant_alias}/users List users in referral programs · List users #

Ask an LLM

“Which participants are enrolled in my Advocate referral programs?”

“Can I search and page through all referral users?”

Tell an agent

List users in tenant {tenant}, {limit} at a time.

Search users in tenant {tenant} matching {query}.

GET /{tenant_alias}/open/account/{accountId}/user/{userId} Look up a user with share links (open endpoint) · Lookup a user (Open Endpoint) #

Ask an LLM

“Can I fetch a referral user along with their share links through the open endpoint?”

“Which extra fields can the open user lookup return besides personal info?”

Tell an agent

Via the open endpoint in tenant {tenant}, get user {user} on account {acct} with their share links.

Open-lookup user {user} on account {acct} in tenant {tenant} including fields {fields}.

PUT /{tenant_alias}/open/account/{accountId}/user/{userId} Create or update a user and account (open endpoint) · User Upsert (Open Endpoint) #

Ask an LLM

“Can I update a referral participant and create their account in one call if it doesn't exist?”

“What does the open upsert do when the user already exists?”

Tell an agent

Upsert user {user} on account {acct} in tenant {tenant} via the open endpoint with email {email}.

Via the open endpoint, update or create user {user} on account {acct} in tenant {tenant} with referred-by codes {codes}.

POST /{tenant_alias}/open/account/{accountId}/user/{userId} Create a new user and account (open endpoint) · Create a user and account (Open Endpoint) #

Ask an LLM

“How do I register a brand-new referral participant and their account together?”

“Does creating a user on the open endpoint need a write token or API key?”

Tell an agent

Create new user {user} with account {acct} in tenant {tenant} via the open endpoint, first name {first}.

Sign up a new open-endpoint user {user} on new account {acct} in tenant {tenant} with email {email}.

DELETE /{tenant_alias}/open/account/{accountId}/user/{userId} Delete a user (open endpoint) · Delete a user (Open Endpoint) #

Ask an LLM

“Can I remove a referral user without deleting the account they belong to?”

“Is there a do-not-track option when deleting a user?”

Tell an agent destructive · confirm first

Delete user {user} from account {acct} in tenant {tenant} via the open endpoint.

Delete open-endpoint user {user} on account {acct} in tenant {tenant} and set do-not-track to {dnt}.

GET /{tenant_alias}/open/user Find a user by referral code (open endpoint) · Get a user by a referral code (Open Endpoint) #

Ask an LLM

“Can a front end resolve a referral code to its user through the open endpoint?”

“Is the open lookup-by-code endpoint enabled by default?”

Tell an agent

Via the open endpoint in tenant {tenant}, find who owns referral code {code}.

Open-lookup the user behind code {code} in tenant {tenant}.

Impact User API

Operations 12

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification