Talon.One · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Third-party Iterable API

4 actions 4 updates phrasing extends openapi/talon-one-iterable-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Talon.One's API. It is a proposal applied on top of the contract, not a document Talon.One publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/iterable/coupon'].get
$.paths['/iterable/referral'].get
$.paths['/iterable/loyalty'].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 Third-party Iterable API
  version: 1.0.0
extends: openapi/talon-one-iterable-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: 3
- target: $.paths['/iterable/coupon'].get
  update:
    x-apievangelist-phrasing:
      intent: Create a coupon code for an Iterable campaign
      effect: write
      questions:
      - How do I drop a freshly generated coupon code into an Iterable message?
      - Can I set an expiry date on coupons created from Iterable?
      instructions:
      - text: Create a coupon for Iterable campaign {iterableCampaignId} in campaign {campaignId}, application {applicationId}, deployment {deployment}.
        slots:
          iterableCampaignId: query.iterableCampaignId
          campaignId: query.campaignId
          applicationId: query.applicationId
          deployment: query.deployment
      - text: Generate an Iterable coupon for recipient {recipientIntegrationId} expiring {expiryDate} in campaign {campaignId}.
        slots:
          recipientIntegrationId: query.recipientIntegrationId
          expiryDate: query.expiryDate
          campaignId: query.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iterable/referral'].get
  update:
    x-apievangelist-phrasing:
      intent: Create a referral code for an Iterable campaign
      effect: write
      questions:
      - How can an Iterable message give an advocate their own referral code?
      - Can I set a usage limit on referral codes created from Iterable?
      instructions:
      - text: Create an Iterable referral code for advocate {advocateProfileIntegrationId} in campaign {campaignId} on deployment {deployment}.
        slots:
          advocateProfileIntegrationId: query.advocateProfileIntegrationId
          campaignId: query.campaignId
          deployment: query.deployment
      - text: Generate an Iterable referral from {advocateProfileIntegrationId} with usage limit {usageLimit}, campaign {campaignId}, deployment {deployment}.
        slots:
          advocateProfileIntegrationId: query.advocateProfileIntegrationId
          usageLimit: query.usageLimit
          campaignId: query.campaignId
          deployment: query.deployment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iterable/loyalty'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer's loyalty ledger for Iterable
      effect: read
      questions:
      - How do I show a customer's loyalty points balance in an Iterable email?
      - Does the Iterable loyalty lookup work with card-based programs?
      instructions:
      - text: Get the loyalty ledger of customer {profileIntegrationId} in program {loyaltyProgramId} for Iterable deployment {deployment}.
        slots:
          profileIntegrationId: query.profileIntegrationId
          loyaltyProgramId: query.loyaltyProgramId
          deployment: query.deployment
      - text: Fetch points for {profileIntegrationId} in loyalty program {loyaltyProgramId} to use in Iterable, deployment {deployment}.
        slots:
          profileIntegrationId: query.profileIntegrationId
          loyaltyProgramId: query.loyaltyProgramId
          deployment: query.deployment
      method: generated
      generated: '2026-09-26'