Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Impact Promo Code Exception Lists API

6 actions 6 updates phrasing extends openapi/impact-promo-code-exception-lists-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['/Advertisers/{AccountSID}/PromoCodeExceptionLists'].post
$.paths['/Advertisers/{AccountSID}/PromoCodeExceptionLists/{ListId}'].get
$.paths['/Advertisers/{AccountSID}/PromoCodeExceptionLists/{ListId}'].put
$.paths['/Mediapartners/{AccountSID}/PromoCodeExceptionLists/{PromoCodeExceptionListId}'].get
$.paths['/Mediapartners/{AccountSID}/PromoCodeExceptionLists/{PromoCodeExceptionListId}/Items'].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 Promo Code Exception Lists API
  version: 1.0.0
extends: openapi/impact-promo-code-exception-lists-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['/Advertisers/{AccountSID}/PromoCodeExceptionLists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a promo code exception list
      effect: write
      questions:
      - How do I set up a list of promo codes that pay a different commission rate?
      - What do I need to create an empty promo code exception list?
      instructions:
      - text: Create promo code exception list {name} for program {campaign} and tracker {tracker} in account {account}.
        slots:
          account: path.AccountSID
          name: requestBody.Name
          campaign: requestBody.CampaignId
          tracker: requestBody.ActionTrackerId
      - text: Start a new empty promo code list called {name} on tracker {tracker}, program {campaign}, account {account}.
        slots:
          account: path.AccountSID
          name: requestBody.Name
          campaign: requestBody.CampaignId
          tracker: requestBody.ActionTrackerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/PromoCodeExceptionLists/{ListId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a brand's promo code exception list
      effect: read
      questions:
      - As a brand, what's configured on one of my promo code exception lists?
      - Can a brand fetch a promo code exception list by its ID?
      instructions:
      - text: As brand account {account}, get promo code exception list {list}.
        slots:
          account: path.AccountSID
          list: path.ListId
      - text: Show brand promo code list {list} in account {account}.
        slots:
          account: path.AccountSID
          list: path.ListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/PromoCodeExceptionLists/{ListId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or retarget a promo code exception list
      effect: write
      questions:
      - Can I rename a promo code exception list or change its action trackers?
      - Which fields of a promo code exception list are editable?
      instructions:
      - text: Rename promo code exception list {list} to {name} in account {account}.
        slots:
          account: path.AccountSID
          list: path.ListId
          name: requestBody.Name
      - text: Point promo code exception list {list} at tracker {tracker} in account {account}.
        slots:
          account: path.AccountSID
          list: path.ListId
          tracker: requestBody.ActionTrackerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/PromoCodeExceptionLists/{PromoCodeExceptionListId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a partner's promo code exception list
      effect: read
      questions:
      - As a partner, can I view a promo code exception list referenced in my contract?
      - Where does a partner find a promo code exception list's details?
      instructions:
      - text: As partner account {account}, retrieve promo code exception list {list}.
        slots:
          account: path.AccountSID
          list: path.PromoCodeExceptionListId
      - text: Get partner-side promo code list {list} for account {account}.
        slots:
          account: path.AccountSID
          list: path.PromoCodeExceptionListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/PromoCodeExceptionLists/{PromoCodeExceptionListId}/Items'].get
  update:
    x-apievangelist-phrasing:
      intent: List codes in a promo code exception list
      effect: read
      questions:
      - Which promo codes trigger an alternate commission rate for me as a partner?
      - Can a partner see every code value inside a promo code exception list?
      instructions:
      - text: As partner account {account}, list the codes in promo code exception list {list}.
        slots:
          account: path.AccountSID
          list: path.PromoCodeExceptionListId
      - text: Show every promo code value on list {list} in account {account}.
        slots:
          account: path.AccountSID
          list: path.PromoCodeExceptionListId
      method: generated
      generated: '2026-09-26'