Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for impact.com Share Links API

4 actions 4 updates phrasing extends openapi/impact-share-links-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 4

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

OpenAPI Overlay

Raw ↑ 
# 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 Share Links API
  version: 1.0.0
extends: openapi/impact-share-links-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}/account/{accountId}/user/{userId}/sharelinks'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's share links (deprecated)
      effect: read
      questions:
      - Is the flat share-links lookup deprecated?
      - What does the old share-links endpoint return per share medium?
      instructions:
      - text: Get legacy share links for user {user} on account {account} in tenant {tenant}.
        slots:
          tenant: path.tenant_alias
          account: path.accountId
          user: path.userId
      - text: Fetch the deprecated flat share link object for user {user}, account {account}.
        slots:
          account: path.accountId
          user: path.userId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{tenant_alias}/account/{accountId}/user/{userId}/shareurls'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's share URLs with an API key
      effect: read
      questions:
      - How do I get a referral user's share URLs from my server?
      - Can I filter share URLs by engagement or share medium?
      instructions:
      - text: Get share URLs for user {user} on account {account} in program {program}, tenant {tenant}, using my API key.
        slots:
          tenant: path.tenant_alias
          account: path.accountId
          user: path.userId
          program: query.programId
      - text: Server-side, list {medium} share URLs for user {user}, account {account}, program {program}.
        slots:
          account: path.accountId
          user: path.userId
          program: query.programId
          medium: query.shareMedium
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{tenant_alias}/open/account/{accountId}/user/{userId}/shareurls'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's share URLs from the client
      effect: read
      questions:
      - Can my web or mobile app fetch a user's share URLs with their JWT?
      - Which share URL endpoint works from the client-side SDKs?
      instructions:
      - text: From the client, get share URLs for user {user} on account {account}, program {program}, tenant {tenant}.
        slots:
          tenant: path.tenant_alias
          account: path.accountId
          user: path.userId
          program: query.programId
      - text: Using the open endpoint, fetch {engagement} share links for user {user}, account {account}, program {program}.
        slots:
          account: path.accountId
          user: path.userId
          program: query.programId
          engagement: query.engagementMedium
      method: generated
      generated: '2026-09-26'