Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Impact Promo Codes API

7 actions 7 updates phrasing extends openapi/impact-promo-codes-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 7

$.info

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

$.paths['/Advertisers/{AccountSID}/PromoCodes'].post

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

$.paths['/Advertisers/{AccountSID}/PromoCodes/{PromoCodeId}'].delete

$.paths['/Mediapartners/{AccountSID}/PromoCodes'].get

$.paths['/Mediapartners/{AccountSID}/PromoCodes/{Id}'].get

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 Promo Codes API
  version: 1.0.0
extends: openapi/impact-promo-codes-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: 6
- target: $.paths['/Advertisers/{AccountSID}/PromoCodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a brand's promo codes
      effect: read
      questions:
      - Which promo codes has my brand issued?
      - Can I filter my promo codes by state or campaign?
      instructions:
      - text: List promo codes in brand account {sid}.
        slots:
          sid: path.AccountSID
      - text: Show my brand promo codes in state {state} for campaign {campaign}.
        slots:
          state: query.State
          campaign: query.CampaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/PromoCodes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a promo code for a partner
      effect: write
      questions:
      - How do I give a partner their own promo code?
      - Can I attach a promo code to a deal when I create it?
      instructions:
      - text: Create {type} promo code {code} for partner {partner} on campaign {campaign} with credit policy {policy} in account {sid}.
        slots:
          sid: path.AccountSID
          type: requestBody.Type
          code: requestBody.Code
          partner: requestBody.AssignedPartnerId
          campaign: requestBody.CampaignId
          policy: requestBody.CreditPolicy
      - text: Assign new code {code} to partner {partner}, campaign {campaign}, type {type}, policy {policy}, deal {deal}.
        slots:
          code: requestBody.Code
          partner: requestBody.AssignedPartnerId
          campaign: requestBody.CampaignId
          type: requestBody.Type
          policy: requestBody.CreditPolicy
          deal: requestBody.DealId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/PromoCodes/{PromoCodeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a brand promo code's details
      effect: read
      questions:
      - Who is a specific promo code on my program assigned to?
      - Can a brand look up one promo code by ID?
      instructions:
      - text: Get brand promo code {code} in account {sid}.
        slots:
          sid: path.AccountSID
          code: path.PromoCodeId
      - text: Show the advertiser details of promo code {code}.
        slots:
          code: path.PromoCodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/PromoCodes/{PromoCodeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Expire a promo code
      effect: destructive
      questions:
      - How do I deactivate a promo code without deleting it?
      - Can I stop a partner's promo code from working?
      instructions:
      - text: Expire promo code {code} in account {sid}.
        slots:
          sid: path.AccountSID
          code: path.PromoCodeId
      - text: Deactivate promo code {code} now.
        slots:
          code: path.PromoCodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/PromoCodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List promo codes available to a partner
      effect: read
      questions:
      - What promo codes can I use as a partner?
      - Can a partner search codes by advertiser or deal?
      instructions:
      - text: List promo codes available to partner account {sid}.
        slots:
          sid: path.AccountSID
      - text: Show partner promo codes from advertiser {adv} matching {search}.
        slots:
          adv: query.AdvertiserId
          search: query.SearchString
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/PromoCodes/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a promo code as a partner
      effect: read
      questions:
      - What are the full details of a promo code I was given?
      - When does a partner promo code start and end?
      instructions:
      - text: Retrieve promo code {id} for partner account {sid}.
        slots:
          sid: path.AccountSID
          id: path.Id
      - text: Show me my partner promo code {id}.
        slots:
          id: path.Id
      method: generated
      generated: '2026-09-26'