Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Brand API - Promo Code Exception Lists Promo Code Exception…

6 actions 6 updates phrasing extends openapi/impact-promo-code-exception-list-items-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/{ListId}/Items'].get
$.paths['/Advertisers/{AccountSID}/PromoCodeExceptionLists/{ListId}/Items'].post
$.paths['/Advertisers/{AccountSID}/PromoCodeExceptionLists/{ListId}/Items'].delete
$.paths['/Advertisers/{AccountSID}/PromoCodeExceptionLists/{ListId}/Items/{ItemId}'].get
$.paths['/Advertisers/{AccountSID}/PromoCodeExceptionLists/{ListId}/Items/{ItemId}'].delete

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 - Promo Code Exception Lists Promo Code Exception…
  version: 1.0.0
extends: openapi/impact-promo-code-exception-list-items-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/{ListId}/Items'].get
  update:
    x-apievangelist-phrasing:
      intent: List codes in a promo code exception list
      effect: read
      questions:
      - Which promo codes are in one of my exception lists?
      - Can I check whether a specific code value is on an exception list?
      instructions:
      - text: List items in promo code exception list {list} for account {sid}.
        slots:
          sid: path.AccountSID
          list: path.ListId
      - text: Find value {value} in promo code exception list {list}.
        slots:
          list: path.ListId
          value: query.Value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/PromoCodeExceptionLists/{ListId}/Items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a code to a promo code exception list
      effect: write
      questions:
      - How do I add a promo code to an exception list?
      - Can I add new code values to an existing promo code exception list?
      instructions:
      - text: Add promo code {value} to exception list {list} in account {sid}.
        slots:
          sid: path.AccountSID
          list: path.ListId
          value: requestBody.Value
      - text: Put code {value} on promo code exception list {list}.
        slots:
          list: path.ListId
          value: requestBody.Value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/PromoCodeExceptionLists/{ListId}/Items'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear every item from a promo code exception list
      effect: destructive
      questions:
      - Can I wipe all the codes out of a promo code exception list at once?
      - Is emptying an entire promo code exception list reversible?
      instructions:
      - text: Delete all items from promo code exception list {list} in account {sid}.
        slots:
          sid: path.AccountSID
          list: path.ListId
      - text: Empty promo code exception list {list} completely.
        slots:
          list: path.ListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/PromoCodeExceptionLists/{ListId}/Items/{ItemId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one promo code exception list item
      effect: read
      questions:
      - What are the details of a single entry on a promo code exception list?
      - Can I look up one exception list item by its ID?
      instructions:
      - text: Get item {item} from promo code exception list {list} in account {sid}.
        slots:
          sid: path.AccountSID
          list: path.ListId
          item: path.ItemId
      - text: Show entry {item} on promo code exception list {list}.
        slots:
          list: path.ListId
          item: path.ItemId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/PromoCodeExceptionLists/{ListId}/Items/{ItemId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one item from a promo code exception list
      effect: destructive
      questions:
      - How do I take a single code off a promo code exception list?
      - Can I delete just one entry and keep the rest of the list?
      instructions:
      - text: Delete item {item} from promo code exception list {list} in account {sid}.
        slots:
          sid: path.AccountSID
          list: path.ListId
          item: path.ItemId
      - text: Remove only entry {item} from exception list {list}.
        slots:
          list: path.ListId
          item: path.ItemId
      method: generated
      generated: '2026-09-26'