Skip to content

Latest commit

 

History

History
61 lines (31 loc) · 2.7 KB

AchievementProgress.md

File metadata and controls

61 lines (31 loc) · 2.7 KB

TalonOne.AchievementProgress

Properties

Name Type Description Notes
achievementId Number The internal ID of the achievement.
name String The internal name of the achievement used in API requests.
title String The display name of the achievement in the Campaign Manager.
description String The description of the achievement in the Campaign Manager.
campaignId Number The ID of the campaign the achievement belongs to.
status String The status of the achievement.
target Number The required number of actions or the transactional milestone to complete the achievement. [optional]
achievementRecurrencePolicy String The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again.
achievementActivationPolicy String The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule.
achievementFixedStartDate Date The achievement's start date when `achievementActivationPolicy` is equal to `fixed_schedule`. Note: It is an RFC3339 timestamp string. [optional]
achievementEndDate Date The achievement's end date. If defined, customers cannot participate in the achievement after this date. Note: It is an RFC3339 timestamp string. [optional]
progress Number The current progress of the customer in the achievement.
startDate Date Timestamp at which the customer started the achievement.
completionDate Date Timestamp at which point the customer completed the achievement. [optional]
endDate Date Timestamp at which point the achievement ends and resets for the customer.
optinDate Date Timestamp at which the customer opted in to the achievement. [optional]

Enum: StatusEnum

  • inprogress (value: "inprogress")

  • completed (value: "completed")

  • expired (value: "expired")

  • opted_in (value: "opted_in")

Enum: AchievementRecurrencePolicyEnum

  • no_recurrence (value: "no_recurrence")

  • on_expiration (value: "on_expiration")

Enum: AchievementActivationPolicyEnum

  • user_action (value: "user_action")

  • fixed_schedule (value: "fixed_schedule")