Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Brand API - Programs Unsubscribed Contacts API

3 actions 3 updates phrasing extends openapi/impact-unsubscribed-contacts-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 3

$.info

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

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

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 API - Programs Unsubscribed Contacts API
  version: 1.0.0
extends: openapi/impact-unsubscribed-contacts-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: 2
- target: $.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/UnsubscribedContacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List contacts who opted out of Outreach
      effect: read
      questions:
      - Who has unsubscribed from my program's Outreach emails?
      - Can I check whether a particular email has opted out?
      instructions:
      - text: List unsubscribed contacts on campaign {campaign} in account {sid}.
        slots:
          sid: path.AccountSID
          campaign: path.CampaignId
      - text: Check if {email} unsubscribed from campaign {campaign}.
        slots:
          campaign: path.CampaignId
          email: query.UserEmail
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/UnsubscribedContacts'].post
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe a contact from Outreach
      effect: write
      questions:
      - How do I stop sending Outreach emails to a partner's contact?
      - Can I opt someone out on behalf of a partner?
      instructions:
      - text: Unsubscribe {email} of partner {partner} from campaign {campaign} in account {sid}.
        slots:
          sid: path.AccountSID
          campaign: path.CampaignId
          email: requestBody.UserEmail
          partner: requestBody.PartnerId
      - text: Opt out {email} for partner {partner} on campaign {campaign}.
        slots:
          campaign: path.CampaignId
          email: requestBody.UserEmail
          partner: requestBody.PartnerId
      method: generated
      generated: '2026-09-26'