Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Brand Partners API

5 actions 5 updates phrasing extends openapi/impact-partners-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['/Advertisers/{AccountSID}/MediaPartners'].get
$.paths['/Advertisers/{AccountSID}/MediaPartners'].post
$.paths['/Advertisers/{AccountSID}/MediaPartners/{PartnerId}'].get
$.paths['/Advertisers/{AccountSID}/MediaPartners/{PartnerId}'].put

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 Partners API
  version: 1.0.0
extends: openapi/impact-partners-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['/Advertisers/{AccountSID}/MediaPartners'].get
  update:
    x-apievangelist-phrasing:
      intent: List a brand's partners
      effect: read
      questions:
      - Who are all the partners in my program?
      - Can I list partners by country, group or relationship state?
      instructions:
      - text: List partners in brand account {sid}.
        slots:
          sid: path.AccountSID
      - text: Show my partners in group {group} from country {country}.
        slots:
          group: query.GroupId
          country: query.Country
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/MediaPartners'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a direct partner account
      effect: write
      questions:
      - How do I sign up a partner directly into my program?
      - What details do I need to create a direct partner account?
      instructions:
      - text: Create direct partner {name} ({site}) in {sid} with user {user}, email {email}, and contract template {template}.
        slots:
          sid: path.AccountSID
          name: requestBody.AccountName
          site: requestBody.Website
          user: requestBody.Username
          email: requestBody.EmailAddress
          template: requestBody.TemplateTermsId
      - text: Onboard {first} {last} at {email} as a direct partner named {name}, currency {currency}.
        slots:
          first: requestBody.FirstName
          last: requestBody.LastName
          email: requestBody.EmailAddress
          name: requestBody.AccountName
          currency: requestBody.Currency
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/MediaPartners/{PartnerId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a partner's details
      effect: read
      questions:
      - What do we know about a specific partner in our program?
      - Can I pull one partner's profile by ID?
      instructions:
      - text: Get partner {partner} in account {sid}.
        slots:
          sid: path.AccountSID
          partner: path.PartnerId
      - text: Show the profile of partner {partner}.
        slots:
          partner: path.PartnerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/MediaPartners/{PartnerId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a partner's custom tracking values
      effect: write
      questions:
      - How do I set the custom MPValue fields used in a partner's tracking links?
      - Can I store my own reference values on a partner?
      instructions:
      - text: Set MPValue1 for partner {partner} in account {sid} to {v1}.
        slots:
          sid: path.AccountSID
          partner: path.PartnerId
          v1: requestBody.MPValue1
      - text: Update partner {partner}'s custom values to {v1}, {v2}, {v3}.
        slots:
          partner: path.PartnerId
          v1: requestBody.MPValue1
          v2: requestBody.MPValue2
          v3: requestBody.MPValue3
      method: generated
      generated: '2026-09-26'