UpdateAchievement.md

UpdateAchievement

Properties

Name	Type	Description	Notes
name	String	The internal name of the achievement used in API requests.	[optional]
title	String	The display name for the achievement in the Campaign Manager.	[optional]
description	String	A description of the achievement.	[optional]
target	BigDecimal	The required number of actions or the transactional milestone to complete the achievement.	[optional]
period	String	The relative duration after which the achievement ends and resets for a particular customer profile.	[optional]
periodEndOverride	TimePoint		[optional]
recurrencePolicy	RecurrencePolicyEnum	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.	[optional]
activationPolicy	ActivationPolicyEnum	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.	[optional]
fixedStartDate	OffsetDateTime	The achievement's start date when `activationPolicy` is set to `fixed_schedule`. Note: It must be an RFC3339 timestamp string.	[optional]
endDate	OffsetDateTime	The achievement's end date. If defined, customers cannot participate in the achievement after this date. Note: It must be an RFC3339 timestamp string.	[optional]

Enum: RecurrencePolicyEnum

Name	Value
NO_RECURRENCE	"no_recurrence"
ON_EXPIRATION	"on_expiration"

Enum: ActivationPolicyEnum

Name	Value
USER_ACTION	"user_action"
FIXED_SCHEDULE	"fixed_schedule"