Create achievements
Some functionality described here is only available in the Closed beta version of the achievements feature. For more information, contact your Customer Success Manager.
Only users with permissions to manage achievements can access this feature.
Create an achievement to check if a customer has reached a defined target. You can create achievements in the Campaign Manager or through the Management API.
Select the type of achievement you want to create:
- Click Achievements on the leftmost menu, then click Create Achievement.
- Select One-time as the recurrence type, then select User action.
- In Name, enter a display name for the achievement.
- In API name, type an identifier for the achievement. It can be used for integration purposes.
- (Optional) In Description, enter a description to help you identify the achievement.
- In Target, enter the target value the customer must reach to complete the achievement.
- (Optional) Select End progress on achieving target to stop a customer's progress in an achievement after they reach the target.
- (Optional) Select Allow progress rollback in completed achievements to enable the rollback of customer progress after the achievement has been completed.
- In Achievement period, define the period after which the achievement ends for each customer.
For example, if you set the achievement period to1 month, you can select the Last day of the month checkbox for the achievement to end on the last day of the month at 23:59:59. - In Time zone, select the reference time zone.
- In Environment, select the environment for your achievement.
- In Connected Applications, select the Applications where you want to use the achievement. You can only connect Applications of the same environment as your achievement.
- Click Create Achievement.
- Click Achievements on the leftmost menu, then click Create Achievement.
- Select One-time as the recurrence type, then select Fixed schedule.
- In Name, enter a display name for the achievement.
- In API name, type an identifier for the achievement. It can be used for integration purposes.
- (Optional) In Description, enter a description to help you identify the achievement.
- In Target, enter the target value the customer must reach to complete the achievement.
- (Optional) Select End progress on achieving target to stop a customer's progress in an achievement after they reach the target.
- (Optional) Select Allow progress rollback in completed achievements to enable the rollback of customer progress after the achievement has been completed.
- Set the following options:
- In Achievement start, set the achievement start date for all customers in the campaign. Individually, the achievement for each customer starts when the customer makes their first progress.
- In Achievement end, set the achievement end date for all customers in the campaign.
- In Time zone, select the reference time zone.
- In Environment, select the environment for your achievement.
- In Connected Applications, select the Applications where you want to use the achievement. You can only connect Applications of the same environment as your achievement.
- Click Create Achievement.
-
Click Achievements on the leftmost menu, then click Create Achievement.
-
Select On expiration as the recurrence type, then select User action.
-
In Name, enter a display name for the achievement.
-
In API name, type an identifier for the achievement. It can be used for integration purposes.
-
(Optional) In Description, enter a description to help you identify the achievement.
-
In Target, enter the target value the customer must reach to complete the achievement.
-
(Optional) Select End progress on achieving target to stop a customer's progress in an achievement after they reach the target.
-
(Optional) Select Allow progress rollback in completed achievements to enable the rollback of customer progress after the achievement has been completed.
-
In Reset every, define the period after which the achievement ends and resets for each customer.
For example, if you set the achievement period to1 month, you can select the Last day of the month checkbox for the achievement to reset on the last day of the month at 23:59:59.noteThe Rule Engine calculates the Reset every period by adding the selected reset frequency to the achievement start date. For example, for a reset frequency of 1 month, an achievement that starts on May 1 resets on June 1. If a valid date does not exist, the Rule Engine uses the next available date. For example, an achievement that starts on January 31 resets on March 1.
-
In Time zone, select the reference time zone.
-
In Environment, select the environment for your achievement.
-
In Connected Applications, select the Applications where you want to use the achievement. You can only connect Applications of the same environment as your achievement.
-
Click Create Achievement.
-
Click Achievements on the leftmost menu, then click Create Achievement.
-
Select On expiration as the recurrence type, then select Fixed schedule.
-
In Name, enter a display name for the achievement.
-
In API name, type an identifier for the achievement. It can be used for integration purposes.
-
(Optional) In Description, enter a description to help you identify the achievement.
-
In Target, enter the target value the customer must reach to complete the achievement.
-
(Optional) Select End progress on achieving target to stop a customer's progress in an achievement after they reach the target.
-
(Optional) Select Allow progress rollback in completed achievements to enable the rollback of customer progress after the achievement has been completed.
-
Set the following options:
- In Achievement start, set the achievement start date for all customers in the campaign. Individually, the achievement for each customer starts when the customer makes their first progress.
- In Reset every, define the period after which the achievement ends and resets for each customer relative to the achievement start.
- (Optional) In Achievement end, set the achievement end date for all customers in the campaign.
noteThe Rule Engine calculates the Reset every period by adding the selected reset frequency to the achievement start date. For example, for a reset frequency of 1 month, an achievement that starts on May 1 resets on June 1. If a valid date does not exist, the Rule Engine uses the next available date. For example, an achievement that starts on January 31 resets on March 1.
-
In Time zone, select the reference time zone.
-
In Environment, select the environment for your achievement.
-
In Connected Applications, select the Applications where you want to use the achievement. You can only connect Applications of the same environment as your achievement.
-
Click Create Achievement.
- Click Achievements on the leftmost menu, then click Create Achievement.
- Select On completion as the recurrence type.
- In Name, enter a display name for the achievement.
- In API name, type an identifier for the achievement. It can be used for integration purposes.
- (Optional) In Description, enter a description to help you identify the achievement.
- In Target, enter the target value the customer must reach to complete the achievement.
- In Environment, select the environment for your achievement.
- In Connected Applications, select the Applications where you want to use the achievement. You can only connect Applications of the same environment as your achievement.
- Click Create Achievement.
Recurring on completion achievements use UTC as the time zone by default.
After creating the achievement, the following applies:
- If a customer has made progress, you can only edit the Name, API name, and Description.
- If the achievement is referenced in a campaign rule, you cannot change the API name or remove the connected Applications used by that rule.