Skip to content

Latest commit

 

History

History
22 lines (17 loc) · 2.34 KB

Achievement.md

File metadata and controls

22 lines (17 loc) · 2.34 KB

Achievement

Properties

Name Type Description Notes
id int Internal ID of this entity.
created datetime The time this entity was created.
name str 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.
title str The display name for the achievement in the Campaign Manager.
description str A description of the achievement.
target float The required number of actions or the transactional milestone to complete the achievement.
period str 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.
period_end_override TimePoint [optional]
campaign_id int ID of the campaign, to which the achievement belongs to
user_id int ID of the user that created this achievement.
created_by str Name of the user that created the achievement. Note: This is not available if the user has been deleted.
has_progress bool Indicates if a customer has made progress in the achievement. [optional]

[Back to Model list] [Back to API list] [Back to README]