Talon.One · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Third-party Emarsys API

4 actions 4 updates phrasing extends openapi/talon-one-emarsys-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['/emarsys/customer_profiles/coupons'].post
$.paths['/emarsys/loyalty_programs/profile/balance'].post
$.paths['/emarsys/customer_profiles/audiences'].post

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 Emarsys API
  version: 1.0.0
extends: openapi/talon-one-emarsys-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['/emarsys/customer_profiles/coupons'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch a coupon code for an Emarsys message
      effect: read
      questions:
      - How can an Emarsys campaign pull a Talon.One coupon code to include in an email?
      - Can I limit how many coupon results Emarsys gets back and add extra customer fields?
      instructions:
      - text: From Emarsys, fetch a coupon from deployment {deployment} with parameters {parameters}, fields {fields}, limit {limit}.
        slots:
          deployment: query.deployment
          parameters: requestBody.parameters
          fields: requestBody.fields
          limit: requestBody.limit
      - text: Get up to {limit} coupon codes for an Emarsys email using parameters {parameters} and fields {fields} on {deployment}.
        slots:
          limit: requestBody.limit
          parameters: requestBody.parameters
          fields: requestBody.fields
          deployment: query.deployment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/emarsys/loyalty_programs/profile/balance'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch a loyalty balance for an Emarsys message
      effect: read
      questions:
      - How can Emarsys show a customer's points balance inside a personalized email?
      - Which balance fields, like pending or expired points, can Emarsys request?
      instructions:
      - text: From Emarsys, get the loyalty balance on deployment {deployment} with parameters {parameters} and fields {fields}.
        slots:
          deployment: query.deployment
          parameters: requestBody.parameters
          fields: requestBody.fields
      - text: Return the active and pending points fields {fields} for the Emarsys profile described by {parameters} on {deployment}.
        slots:
          fields: requestBody.fields
          parameters: requestBody.parameters
          deployment: query.deployment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/emarsys/customer_profiles/audiences'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync audiences from Emarsys to customer profiles
      effect: write
      questions:
      - How do I push Emarsys segment membership into Talon.One audiences?
      - Will Emarsys audience sync create customer profiles that don't exist yet?
      instructions:
      - text: Sync Emarsys audience changes {parameters} to deployment {deployment}.
        slots:
          parameters: requestBody.parameters
          deployment: query.deployment
      - text: Update audiences for many profiles from Emarsys on {deployment} using {parameters}.
        slots:
          deployment: query.deployment
          parameters: requestBody.parameters
      method: generated
      generated: '2026-09-26'