Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for impact.com API - User Open Endpoint API

6 actions 6 updates phrasing extends openapi/impact-open-endpoint-api-openapi.yml

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.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/{tenant_alias}/open/account/{accountId}/user/{userId}'].get

$.paths['/{tenant_alias}/open/account/{accountId}/user/{userId}'].put

$.paths['/{tenant_alias}/open/account/{accountId}/user/{userId}'].post

$.paths['/{tenant_alias}/open/account/{accountId}/user/{userId}'].delete

$.paths['/{tenant_alias}/open/user'].get

OpenAPI Overlay

# 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 API - User Open Endpoint API
  version: 1.0.0
extends: openapi/impact-open-endpoint-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: 5
- target: $.paths['/{tenant_alias}/open/account/{accountId}/user/{userId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a user with share links (open endpoint)
      effect: read
      questions:
      - 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?
      instructions:
      - text: Via the open endpoint in tenant {tenant}, get user {user} on account {acct} with their share links.
        slots:
          tenant: path.tenant_alias
          acct: path.accountId
          user: path.userId
      - text: Open-lookup user {user} on account {acct} in tenant {tenant} including fields {fields}.
        slots:
          tenant: path.tenant_alias
          acct: path.accountId
          user: path.userId
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{tenant_alias}/open/account/{accountId}/user/{userId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a user and account (open endpoint)
      effect: write
      questions:
      - 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?
      instructions:
      - text: Upsert user {user} on account {acct} in tenant {tenant} via the open endpoint with email {email}.
        slots:
          tenant: path.tenant_alias
          acct: path.accountId
          user: path.userId
          email: requestBody.email
      - text: Via the open endpoint, update or create user {user} on account {acct} in tenant {tenant} with referred-by codes {codes}.
        slots:
          tenant: path.tenant_alias
          acct: path.accountId
          user: path.userId
          codes: requestBody.referredByCodes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{tenant_alias}/open/account/{accountId}/user/{userId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new user and account (open endpoint)
      effect: write
      questions:
      - 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?
      instructions:
      - text: Create new user {user} with account {acct} in tenant {tenant} via the open endpoint, first name {first}.
        slots:
          tenant: path.tenant_alias
          acct: path.accountId
          user: path.userId
          first: requestBody.firstName
      - text: Sign up a new open-endpoint user {user} on new account {acct} in tenant {tenant} with email {email}.
        slots:
          tenant: path.tenant_alias
          acct: path.accountId
          user: path.userId
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{tenant_alias}/open/account/{accountId}/user/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user (open endpoint)
      effect: destructive
      questions:
      - Can I remove a referral user without deleting the account they belong to?
      - Is there a do-not-track option when deleting a user?
      instructions:
      - text: Delete user {user} from account {acct} in tenant {tenant} via the open endpoint.
        slots:
          tenant: path.tenant_alias
          acct: path.accountId
          user: path.userId
      - text: Delete open-endpoint user {user} on account {acct} in tenant {tenant} and set do-not-track to {dnt}.
        slots:
          tenant: path.tenant_alias
          acct: path.accountId
          user: path.userId
          dnt: query.doNotTrack
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{tenant_alias}/open/user'].get
  update:
    x-apievangelist-phrasing:
      intent: Find a user by referral code (open endpoint)
      effect: read
      questions:
      - 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?
      instructions:
      - text: Via the open endpoint in tenant {tenant}, find who owns referral code {code}.
        slots:
          tenant: path.tenant_alias
          code: query.referralCode
      - text: Open-lookup the user behind code {code} in tenant {tenant}.
        slots:
          tenant: path.tenant_alias
          code: query.referralCode
      method: generated
      generated: '2026-09-26'