# 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 Braze API
  version: 1.0.0
extends: openapi/talon-one-braze-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['/braze/referral'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a referral code for a Braze campaign
      effect: write
      questions:
      - How do I generate a referral code for an advocate from a Braze message?
      - Can I test Braze referral creation without saving it?
      instructions:
      - text: Create a referral code for advocate {advocateProfileIntegrationId} in campaign {campaignId} on deployment {deploymentUrl} for Braze.
        slots:
          advocateProfileIntegrationId: requestBody.advocateProfileIntegrationId
          campaignId: requestBody.campaignId
          deploymentUrl: requestBody.deploymentUrl
      - text: Generate a Braze referral from {advocateProfileIntegrationId} to friend {friendProfileIntegrationId}, campaign {campaignId}, deployment {deploymentUrl}.
        slots:
          advocateProfileIntegrationId: requestBody.advocateProfileIntegrationId
          friendProfileIntegrationId: requestBody.friendProfileIntegrationId
          campaignId: requestBody.campaignId
          deploymentUrl: requestBody.deploymentUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/braze/coupon'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a coupon code for a Braze message
      effect: write
      questions:
      - How do I insert a unique coupon code into a Braze email?
      - Can the Braze coupon call return an existing coupon instead of creating a new one?
      instructions:
      - text: Create a coupon for Braze in campaign {campaignId} of application {applicationId} with identifier {identifier} on {deploymentUrl}.
        slots:
          campaignId: requestBody.campaignId
          applicationId: requestBody.applicationId
          identifier: requestBody.identifier
          deploymentUrl: requestBody.deploymentUrl
      - text: Generate a Braze coupon for customer {integrationId}, identifier {identifier}, campaign {campaignId}, application {applicationId}, deployment {deploymentUrl}.
        slots:
          integrationId: requestBody.integrationId
          identifier: requestBody.identifier
          campaignId: requestBody.campaignId
          applicationId: requestBody.applicationId
          deploymentUrl: requestBody.deploymentUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/braze/coupon_reservation'].post
  update:
    x-apievangelist-phrasing:
      intent: Reserve a coupon for a customer from Braze
      effect: write
      questions:
      - Can a Braze campaign reserve a coupon code for the recipient?
      - What does Braze need to send to reserve a coupon for a profile?
      instructions:
      - text: Reserve coupon {couponValue} for customer {integrationId} from Braze on {deploymentUrl}.
        slots:
          couponValue: requestBody.couponValue
          integrationId: requestBody.integrationId
          deploymentUrl: requestBody.deploymentUrl
      - text: From Braze, hold coupon {couponValue} for profile {integrationId} at deployment {deploymentUrl}.
        slots:
          couponValue: requestBody.couponValue
          integrationId: requestBody.integrationId
          deploymentUrl: requestBody.deploymentUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/braze/event'].post
  update:
    x-apievangelist-phrasing:
      intent: Track a custom event from Braze
      effect: write
      questions:
      - How do I send a Braze event so it triggers promotion rules?
      - Does a custom event from Braze have to be defined in the Campaign Manager first?
      instructions:
      - text: Track Braze event {eventType} of type {type} for customer {customerProfileId} with identifier {identifier} on {destination-hostname}.
        slots:
          eventType: requestBody.eventType
          type: requestBody.type
          customerProfileId: requestBody.customerProfileId
          identifier: requestBody.identifier
          destination-hostname: header.destination-hostname
      - text: Send event {eventType} ({type}) with attributes {eventAttributes} from Braze for {customerProfileId}, identifier {identifier}, host {destination-hostname}.
        slots:
          eventType: requestBody.eventType
          type: requestBody.type
          eventAttributes: requestBody.eventAttributes
          customerProfileId: requestBody.customerProfileId
          identifier: requestBody.identifier
          destination-hostname: header.destination-hostname
      method: generated
      generated: '2026-09-26'