Talon.One · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Third-party Customer data platforms API
8 actions
8 updates
phrasing
extends
openapi/talon-one-customer-data-platforms-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.
What the actions change
x-apievangelist-phrasing
Targets 8
$.info
$.paths['/cdp/customer_profile/{customerProfileId}'].put
$.paths['/cdp/customer_profile/{customerProfileId}/audiences'].put
$.paths['/cdp/customer_profiles/audiences'].put
$.paths['/cdp/v2/customer_profiles/audiences'].put
$.paths['/cdp/audiences'].post
$.paths['/cdp/audiences/{audienceId}'].put
$.paths['/cdp/audiences/{audienceId}'].delete
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 Third-party Customer data platforms API
version: 1.0.0
extends: openapi/talon-one-customer-data-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: 7
- target: $.paths['/cdp/customer_profile/{customerProfileId}'].put
update:
x-apievangelist-phrasing:
intent: Update or create a customer profile from a CDP
effect: write
questions:
- How does my customer data platform push profile attributes into Talon.One?
- Can a CDP profile sync skip attributes that don't exist yet instead of failing?
- Will updating a profile from my CDP trigger the Rule Builder?
instructions:
- text: From CDP {cdpName}, set attributes {attributes} on customer profile {customerProfileId}.
slots:
cdpName: header.customer-data-platform-name
attributes: requestBody.attributes
customerProfileId: path.customerProfileId
- text: Sync profile {customerProfileId} from CDP {cdpName} to deployment {host}, with skip-unknown-attributes set to {skip}.
slots:
customerProfileId: path.customerProfileId
cdpName: header.customer-data-platform-name
host: header.destination-hostname
skip: query.skipNonExistingAttributes
method: generated
generated: '2026-09-26'
- target: $.paths['/cdp/customer_profile/{customerProfileId}/audiences'].put
update:
x-apievangelist-phrasing:
intent: Change one profile's audiences from a CDP
effect: write
questions:
- How does my CDP add a single customer to an audience or take them out of one?
- Can I identify audiences by their ID in my CDP when updating one profile's membership?
instructions:
- text: From CDP {cdpName}, update audience membership of profile {customerProfileId} with {data}.
slots:
cdpName: header.customer-data-platform-name
customerProfileId: path.customerProfileId
data: requestBody.data
- text: Add or remove single profile {customerProfileId} from audiences {data} on deployment {host}.
slots:
customerProfileId: path.customerProfileId
data: requestBody.data
host: header.destination-hostname
method: generated
generated: '2026-09-26'
- target: $.paths['/cdp/customer_profiles/audiences'].put
update:
x-apievangelist-phrasing:
intent: Update audiences for many profiles from a CDP
effect: write
questions:
- Can my CDP update audience membership for lots of customers in one call using Talon.One audience IDs?
- What happens to customer profiles that don't exist yet during a bulk audience update?
instructions:
- text: From CDP {cdpName}, apply bulk audience changes {data} using internal audience IDs.
slots:
cdpName: header.customer-data-platform-name
data: requestBody.data
- text: Update audiences for multiple profiles on deployment {host} with {data}, the v1 bulk call.
slots:
host: header.destination-hostname
data: requestBody.data
method: generated
generated: '2026-09-26'
- target: $.paths['/cdp/v2/customer_profiles/audiences'].put
update:
x-apievangelist-phrasing:
intent: Update audiences for many profiles by external ID
effect: write
questions:
- Can my CDP bulk-update audiences using its own external audience IDs?
- Which bulk audience call lets me reference audiences by the ID from my third-party platform?
instructions:
- text: From CDP {cdpName}, apply v2 bulk audience changes {data} keyed by external audience IDs.
slots:
cdpName: header.customer-data-platform-name
data: requestBody.data
- text: Using external IDs, update many profiles' audiences with {data} on deployment {host}.
slots:
data: requestBody.data
host: header.destination-hostname
method: generated
generated: '2026-09-26'
- target: $.paths['/cdp/audiences'].post
update:
x-apievangelist-phrasing:
intent: Create an audience from a CDP
effect: write
questions:
- How do I bring an audience segment from my CDP into Talon.One?
- Does creating the first audience unlock audience conditions in the Rule Builder?
instructions:
- text: Create audience {audienceName} with external ID {audienceId} from CDP {cdpName}.
slots:
audienceName: requestBody.audienceName
audienceId: requestBody.audienceId
cdpName: header.customer-data-platform-name
- text: Create a new CDP audience {audienceName} (ID {audienceId}) on deployment {host}.
slots:
audienceName: requestBody.audienceName
audienceId: requestBody.audienceId
host: header.destination-hostname
method: generated
generated: '2026-09-26'
- target: $.paths['/cdp/audiences/{audienceId}'].put
update:
x-apievangelist-phrasing:
intent: Rename an audience created by a CDP
effect: write
questions:
- How do I update the name of an audience my CDP created?
- Can I change an existing third-party audience's details from my CDP?
instructions:
- text: Rename CDP audience {audienceId} to {audienceName}.
slots:
audienceId: path.audienceId
audienceName: requestBody.audienceName
- text: Update audience {audienceId} from CDP {cdpName} with name {audienceName}.
slots:
audienceId: path.audienceId
cdpName: header.customer-data-platform-name
audienceName: requestBody.audienceName
method: generated
generated: '2026-09-26'
- target: $.paths['/cdp/audiences/{audienceId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an audience created by a CDP
effect: destructive
questions:
- How do I remove an audience that came from my CDP?
- Does deleting a CDP audience also drop every customer's membership in it?
instructions:
- text: Delete CDP audience {audienceId}.
slots:
audienceId: path.audienceId
- text: Remove audience {audienceId} created by CDP {cdpName}, including its profile links.
slots:
audienceId: path.audienceId
cdpName: header.customer-data-platform-name
method: generated
generated: '2026-09-26'