Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Impact Company Information API

5 actions 5 updates phrasing extends openapi/impact-company-information-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 5

$.info

$.paths['/Agencies/{AccountSID}/CompanyInformation'].get

$.paths['/Agencies/{AccountSID}/CompanyInformation'].put

$.paths['/Advertisers/{AccountSID}/CompanyInformation'].get

$.paths['/Advertisers/{AccountSID}/CompanyInformation'].put

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 Company Information API
  version: 1.0.0
extends: openapi/impact-company-information-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: 4
- target: $.paths['/Agencies/{AccountSID}/CompanyInformation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agency's company profile
      effect: read
      questions:
      - What company details does impact.com hold for my agency?
      - Where can I see my agency's registered addresses and tax details?
      instructions:
      - text: Get the agency company profile for account {sid}.
        slots:
          sid: path.AccountSID
      - text: Show agency {sid}'s contacts and platform preferences.
        slots:
          sid: path.AccountSID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Agencies/{AccountSID}/CompanyInformation'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an agency's company profile
      effect: write
      questions:
      - Can my agency change its timezone or currency through the API?
      - How do I update my agency's website or phone number?
      instructions:
      - text: Update agency {sid}'s website to {site}.
        slots:
          sid: path.AccountSID
          site: requestBody.Website
      - text: Set agency {sid}'s timezone to {tz}.
        slots:
          sid: path.AccountSID
          tz: requestBody.Timezone
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/CompanyInformation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a brand's company information
      effect: read
      questions:
      - What company details are on my brand account?
      - Can I read the brand profile tied to my API keys?
      instructions:
      - text: Get brand company information for advertiser account {sid}.
        slots:
          sid: path.AccountSID
      - text: Show the corporate and billing address on brand account {sid}.
        slots:
          sid: path.AccountSID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/CompanyInformation'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a brand's company information
      effect: write
      questions:
      - How do I change my brand's billing address?
      - Which brand profile fields can't be updated via the API?
      instructions:
      - text: Change brand account {sid}'s company name to {name}.
        slots:
          sid: path.AccountSID
          name: requestBody.CompanyName
      - text: Update advertiser {sid}'s billing city to {city}.
        slots:
          sid: path.AccountSID
          city: requestBody.BillingAddressCity
      method: generated
      generated: '2026-09-26'