Talon.One

Talon.One Achievements API

Represents achievements that reward a customer profile for performing a number of specific actions or reaching a transactional milestone within a defined period. For example, you can use achievements to award your customers when they purchase five cups of coffee in one week or when they purchase items worth $3000 in three months.

Documentation GitHub OpenAPI

Business capability

Loyalty & Retention Management BC-420.40

Operations 15

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/customer_profiles/{integrationId}/achievements List achievements available to a customer · List customer's available achievements #

Ask an LLM

“Which achievements can a given customer work toward, and how far along are they?”

“Can I show a shopper only the achievements they are still in progress on?”

Tell an agent

List the achievements available to customer {integrationId} with their progress.

Show customer {integrationId}'s achievements whose current progress status is {currentProgressStatus}.

GET /v1/customer_profiles/{integrationId}/achievements/{achievementId} Get a customer's progress history in one achievement · List customer's achievement history #

Ask an LLM

“How has a customer progressed through one achievement over time?”

“Can I see a customer's completed attempts at a recurring achievement between two dates?”

Tell an agent

Show customer {integrationId}'s progress history for achievement {achievementId}.

List customer {integrationId}'s history in achievement {achievementId} from {startDate} to {endDate}.

POST /v1/applications/{applicationId}/campaigns/{campaignId}/achievements Create an achievement inside a campaign · Create achievement #

Ask an LLM

“How do I add a campaign-level achievement like spend 100 in 30 days?”

“Can a campaign achievement recur after the customer completes it?”

Tell an agent

Create achievement {title} with target {target} in campaign {campaignId} of application {applicationId}.

Add a campaign achievement {name} over period {period} to campaign {campaignId}, application {applicationId}.

GET /v1/applications/{applicationId}/campaigns/{campaignId}/achievements List a campaign's achievements · List achievements #

Ask an LLM

“Which achievements are set up inside a specific campaign?”

“Can I filter a campaign's achievements by title?”

Tell an agent

List the achievements in campaign {campaignId} of application {applicationId}.

Find campaign achievements titled {title} in campaign {campaignId}, application {applicationId}.

GET /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} Get one achievement in a campaign · Get achievement #

Ask an LLM

“What target and period does a particular campaign achievement use?”

“Where can I see the settings of an achievement that lives in a campaign?”

Tell an agent

Get achievement {achievementId} from campaign {campaignId} in application {applicationId}.

Show the settings of campaign achievement {achievementId} (campaign {campaignId}, application {applicationId}).

PUT /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} Update an achievement inside a campaign · Update achievement #

Ask an LLM

“Can I change the target of an achievement that belongs to a campaign?”

“Is it possible to move the end date of a campaign achievement?”

Tell an agent

Change the target of campaign achievement {achievementId} in campaign {campaignId}, application {applicationId}, to {target}.

Set the end date of achievement {achievementId} in campaign {campaignId} of application {applicationId} to {endDate}.

DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} Delete an achievement from a campaign · Delete achievement #

Ask an LLM

“How do I remove an achievement from a campaign?”

“Can I delete a campaign achievement customers are already progressing in?”

Tell an agent destructive · confirm first

Delete achievement {achievementId} from campaign {campaignId} in application {applicationId}.

Remove campaign achievement {achievementId} (campaign {campaignId}, application {applicationId}).

GET /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/export Export participants of a campaign achievement to CSV · Export achievement customer data #

Ask an LLM

“Can I download a CSV of every customer participating in a campaign's achievement?”

“What columns are in the campaign achievement participant export?”

Tell an agent

Export customer data for achievement {achievementId} in campaign {campaignId}, application {applicationId}.

Download the participant CSV of campaign achievement {achievementId} (campaign {campaignId}, application {applicationId}).

GET /v2/achievements List account-level achievements · List achievements #

Ask an LLM

“What achievements exist across my whole account?”

“Can I narrow account-level achievements to those subscribed by one Application?”

Tell an agent

List all account-level achievements.

Show account achievements used by application {applicationId}.

POST /v2/achievements Create an account-level achievement · Create achievement #

Ask an LLM

“How do I create an achievement shared by several Applications?”

“Which time zone and sandbox settings does an account-level achievement need?”

Tell an agent

Create an account-level achievement {title} in time zone {timezone} with sandbox {sandbox}.

Create account achievement {name} for applications {subscribedApplications}, time zone {timezone}, sandbox {sandbox}.

GET /v2/achievements/{achievementId} Get an account-level achievement · Get achievement #

Ask an LLM

“Which Applications subscribe to an account-level achievement?”

“Where do I read the details of an achievement by its ID alone?”

Tell an agent

Get account-level achievement {achievementId}.

Show which applications subscribe to achievement {achievementId}.

PUT /v2/achievements/{achievementId} Update an account-level achievement · Update achievement #

Ask an LLM

“Can I subscribe more Applications to an existing account-level achievement?”

“Is it possible to change the target of an account-wide achievement?”

Tell an agent

Subscribe applications {subscribedApplications} to account achievement {achievementId}.

Update the target of account-level achievement {achievementId} to {target}.

DELETE /v2/achievements/{achievementId} Delete an account-level achievement · Delete achievement #

Ask an LLM

“How do I delete an achievement that isn't tied to a single campaign?”

“Can I remove an account-wide achievement by ID?”

Tell an agent destructive · confirm first

Delete account-level achievement {achievementId}.

Remove the account-wide achievement {achievementId}.

GET /v2/achievements/{achievementId}/export Export participants of an account achievement to CSV · Export achievement customer data #

Ask an LLM

“Can I download everyone taking part in an account-level achievement?”

“Is there a CSV export for account-wide achievement participants?”

Tell an agent

Export the participant CSV for account-level achievement {achievementId}.

Download customer progress data for account achievement {achievementId}.

GET /v1/applications/{applicationId}/achievement_progress/{integrationId} List a customer's achievement progress in an Application · List customer achievements #

Ask an LLM

“What achievements has a customer made progress on within one Application?”

“Can I check a customer's progress for a single achievement from the management side?”

Tell an agent

List achievement progress for customer {integrationId} in application {applicationId}.

Show customer {integrationId}'s progress on achievement {achievementId} in application {applicationId}.

Talon.One Achievements API

Operations 15

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification