Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Brand Partner Groups API

6 actions 6 updates phrasing extends openapi/impact-partner-groups-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}/Campaigns/{CampaignId}/MediaPartnerGroups'].get

$.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/MediaPartnerGroups'].post

$.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/MediaPartnerGroups/{PartnerGroupId}'].get

$.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/MediaPartnerGroups/{PartnerGroupId}'].put

$.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/MediaPartnerGroups/{PartnerGroupId}'].delete

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 Brand Partner Groups API
  version: 1.0.0
extends: openapi/impact-partner-groups-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}/Campaigns/{CampaignId}/MediaPartnerGroups'].get
  update:
    x-apievangelist-phrasing:
      intent: List partner groups on a campaign
      effect: read
      questions:
      - What partner groups exist on my campaign?
      - Where can I see all the ways I've grouped partners?
      instructions:
      - text: List partner groups for campaign {campaign} in account {sid}.
        slots:
          sid: path.AccountSID
          campaign: path.CampaignId
      - text: Show every partner group in campaign {campaign}.
        slots:
          campaign: path.CampaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/MediaPartnerGroups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a partner group
      effect: write
      questions:
      - How do I create a group to organize partners?
      - Can I add partners at the same time I create a group?
      instructions:
      - text: Create partner group {name} on campaign {campaign} in account {sid}.
        slots:
          sid: path.AccountSID
          campaign: path.CampaignId
          name: requestBody.Name
      - text: Make group {name} in campaign {campaign} containing partners {partners}.
        slots:
          campaign: path.CampaignId
          name: requestBody.Name
          partners: requestBody.MediaPartners
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/MediaPartnerGroups/{PartnerGroupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a partner group and its members
      effect: read
      questions:
      - Which partners belong to a particular group?
      - Can I see a single partner group's details?
      instructions:
      - text: Get partner group {group} on campaign {campaign} in account {sid}.
        slots:
          sid: path.AccountSID
          campaign: path.CampaignId
          group: path.PartnerGroupId
      - text: Show the members of partner group {group} in campaign {campaign}.
        slots:
          campaign: path.CampaignId
          group: path.PartnerGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/MediaPartnerGroups/{PartnerGroupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or change members of a partner group
      effect: write
      questions:
      - How do I add partners to an existing group?
      - Can I rename a partner group?
      instructions:
      - text: Rename partner group {group} on campaign {campaign} in {sid} to {name}.
        slots:
          sid: path.AccountSID
          campaign: path.CampaignId
          group: path.PartnerGroupId
          name: requestBody.Name
      - text: Add partners {add} to group {group} in campaign {campaign}.
        slots:
          campaign: path.CampaignId
          group: path.PartnerGroupId
          add: requestBody.MediaPartnersAdd
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/MediaPartnerGroups/{PartnerGroupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a partner group
      effect: destructive
      questions:
      - What happens to partners when I delete their group?
      - Can I remove a partner group I no longer use?
      instructions:
      - text: Delete partner group {group} from campaign {campaign} in account {sid}.
        slots:
          sid: path.AccountSID
          campaign: path.CampaignId
          group: path.PartnerGroupId
      - text: Remove the partner group {group} in campaign {campaign}.
        slots:
          campaign: path.CampaignId
          group: path.PartnerGroupId
      method: generated
      generated: '2026-09-26'