Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 3.4 KB

File metadata and controls

58 lines (39 loc) · 3.4 KB

AchievementProgressWithDefinition

The current progress of the customer in the achievement.

Properties

Name Type Description Notes
status StatusEnum The status of the achievement.
progress BigDecimal The current progress of the customer in the achievement.
startDate OffsetDateTime Timestamp at which the customer started the achievement. [optional]
completionDate OffsetDateTime Timestamp at which point the customer completed the achievement. [optional]
endDate OffsetDateTime Timestamp at which point the achievement ends and resets for the customer. [optional]
achievementId Long 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 Long The ID of the campaign the achievement belongs to.
target BigDecimal The required number of actions or the transactional milestone to complete the achievement. [optional]
achievementRecurrencePolicy AchievementRecurrencePolicyEnum 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. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again.
achievementActivationPolicy AchievementActivationPolicyEnum 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 OffsetDateTime The achievement's start date when `achievementActivationPolicy` is equal to `fixed_schedule`. Note: It is an RFC3339 timestamp string. [optional]
achievementEndDate OffsetDateTime The achievement's end date. If defined, customers cannot participate in the achievement after this date. Note: It is an RFC3339 timestamp string. [optional]
achievementAllowRollbackAfterCompletion Boolean When `true`, customer progress can be rolled back in completed achievements. [optional]

Enum: StatusEnum

Name Value
INPROGRESS "inprogress"
COMPLETED "completed"
EXPIRED "expired"
NOT_STARTED "not_started"

Enum: AchievementRecurrencePolicyEnum

Name Value
NO_RECURRENCE "no_recurrence"
ON_EXPIRATION "on_expiration"
ON_COMPLETION "on_completion"

Enum: AchievementActivationPolicyEnum

Name Value
USER_ACTION "user_action"
FIXED_SCHEDULE "fixed_schedule"