# 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 Customer engagement platforms API
  version: 1.0.0
extends: openapi/talon-one-customer-engagement-platforms-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: 4
- target: $.paths['/customer_engagement/coupon'].get
  update:
    x-apievangelist-phrasing:
      intent: Create a coupon from an engagement platform
      effect: write
      questions:
      - How can my email or messaging platform generate a coupon code for a recipient?
      - Can I test coupon creation from my engagement platform with a dry run?
      instructions:
      - text: Create a coupon in campaign {campaignId} of Application {applicationId} for external campaign {externalCampaignId}.
        slots:
          campaignId: query.campaignId
          applicationId: query.applicationId
          externalCampaignId: query.externalCampaignId
      - text: Create a CEP coupon for recipient {recipientIntegrationId} in campaign {campaignId}, Application {applicationId}, external campaign {externalCampaignId}.
        slots:
          recipientIntegrationId: query.recipientIntegrationId
          campaignId: query.campaignId
          applicationId: query.applicationId
          externalCampaignId: query.externalCampaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customer_engagement/referral'].get
  update:
    x-apievangelist-phrasing:
      intent: Create a referral from an engagement platform
      effect: write
      questions:
      - Can my messaging platform generate a referral code for an advocate inside a campaign message?
      - How do I create a referral code from an engagement platform without actually saving it?
      instructions:
      - text: From engagement platform {cepName}, create a referral for advocate {advocateProfileIntegrationId} in campaign {campaignId}.
        slots:
          cepName: header.customer-engagement-platform-name
          advocateProfileIntegrationId: query.advocateProfileIntegrationId
          campaignId: query.campaignId
      - text: Generate a CEP referral code in campaign {campaignId} for advocate {advocateProfileIntegrationId} expiring {expiryDate}.
        slots:
          campaignId: query.campaignId
          advocateProfileIntegrationId: query.advocateProfileIntegrationId
          expiryDate: query.expiryDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customer_engagement/loyalty'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer's loyalty ledger for an engagement platform
      effect: read
      questions:
      - How can my email platform show a customer's points balance in a message?
      - Does the engagement platform loyalty lookup work with card-based programs?
      instructions:
      - text: From engagement platform {cepName}, get the loyalty ledger of customer {profileIntegrationId} in program {loyaltyProgramId}.
        slots:
          cepName: header.customer-engagement-platform-name
          profileIntegrationId: query.profileIntegrationId
          loyaltyProgramId: query.loyaltyProgramId
      - text: Fetch points for profile {profileIntegrationId} in loyalty program {loyaltyProgramId} for use in a CEP message.
        slots:
          profileIntegrationId: query.profileIntegrationId
          loyaltyProgramId: query.loyaltyProgramId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customer_engagement/add_loyalty_points'].post
  update:
    x-apievangelist-phrasing:
      intent: Add loyalty points from an engagement platform
      effect: write
      questions:
      - Can my engagement platform reward a customer with points when they open a campaign email?
      - Which loyalty program types accept points added from an engagement platform?
      instructions:
      - text: From engagement platform {cepName}, add {points} points to customer {profileIntegrationId} in program {loyaltyProgramId}.
        slots:
          cepName: header.customer-engagement-platform-name
          points: requestBody.points
          profileIntegrationId: requestBody.profileIntegrationId
          loyaltyProgramId: requestBody.loyaltyProgramId
      - text: Grant {points} CEP reward points to profile {profileIntegrationId} in loyalty program {loyaltyProgramId}, expiring {validUntil}.
        slots:
          points: requestBody.points
          profileIntegrationId: requestBody.profileIntegrationId
          loyaltyProgramId: requestBody.loyaltyProgramId
          validUntil: requestBody.validUntil
      method: generated
      generated: '2026-09-26'