| Name | Type | Description | Notes |
|---|---|---|---|
| name | String | The internal name of the achievement used in API requests. Note: The name should start with a letter. This cannot be changed after the achievement has been created. | [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. Note: The `period` does not start when the achievement is created. The period is a positive real number followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` Note: You can either use the round down and round up option or set an absolute period. | [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. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets 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] |
| allowRollbackAfterCompletion | Boolean | When `true`, customer progress can be rolled back in completed achievements. | [optional] |
| Name | Value |
|---|---|
| NO_RECURRENCE | "no_recurrence" |
| ON_EXPIRATION | "on_expiration" |
| ON_COMPLETION | "on_completion" |
| Name | Value |
|---|---|
| USER_ACTION | "user_action" |
| FIXED_SCHEDULE | "fixed_schedule" |