Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Brand API - Account Information Legal Entities API

3 actions 3 updates phrasing extends openapi/impact-legal-entities-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 3

$.info
$.paths['/Advertisers/{AccountSID}/LegalEntities'].get
$.paths['/Advertisers/{AccountSID}/LegalEntities/{LegalEntityId}'].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 Brand API - Account Information Legal Entities API
  version: 1.0.0
extends: openapi/impact-legal-entities-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['/Advertisers/{AccountSID}/LegalEntities'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's legal entities
      effect: read
      questions:
      - Which legal entities are tied to my brand account?
      - Can I see all the legal entities used for billing?
      instructions:
      - text: List the legal entities for account {account}.
        slots:
          account: path.AccountSID
      - text: Show every legal entity on brand account {account}.
        slots:
          account: path.AccountSID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/LegalEntities/{LegalEntityId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a legal entity
      effect: read
      questions:
      - What details are held for one legal entity on my account?
      - Can I fetch a single legal entity by ID?
      instructions:
      - text: Get legal entity {entity} in account {account}.
        slots:
          account: path.AccountSID
          entity: path.LegalEntityId
      - text: Show the details of legal entity {entity}, account {account}.
        slots:
          account: path.AccountSID
          entity: path.LegalEntityId
      method: generated
      generated: '2026-09-26'