What is a benefit definition?
Much like achievement definitions, benefit definitions are a configurable ‘template’ used when adding a benefit. Use Add Benefit Definition to create a benefit definition. After this, you can then Add Benefit using your newly created definition.See Benefits for a full explanation of how benefits work, including the claim and redemption lifecycle.
Benefit definition properties
| Attribute | Description |
|---|---|
id INTEGER READ-ONLY | The unique Omneo ID of the definition |
name STRING | The display name of the definition |
handle STRING | The unique handle for the definition |
period INTEGER | Valid for (in Days) |
description STRING | The internal description for the definition |
internal_notes STRING | Internal notes against this definition |
short_description STRING | A publicly available short description for this definition |
long_description STRING | A publicly available full HTML description for this definition |
terms_conditions STRING | Terms and conditions attached to this condition |
redeem_instructions_store STRING | Instructions to redeem in a physical store |
redeem_instructions_online STRING | Instructions to redeem online |
redeem_code_pos STRING | A redemption code used at the Point of Sale |
redeem_code_online STRING | A redemption code used Online |
icon URL | A valid URL for the icon associated with this definition |
image_url URL | A valid URL for the cover image associated with this definition |
max_redemptions INTEGER | The total redemptions available for an individual |
is_extendable BOOLEAN | Denotes whether this definition’s end date can be extended |
is_assignable BOOLEAN | Denotes whether this definition can be assigned to an Omneo profile |
is_reassignable BOOLEAN | Denotes whether this benefit can be reassigned once already assigned to a profile |
is_published BOOLEAN | Denotes whether this benefit is published and is visible to the customer |
is_archived BOOLEAN | Denotes whether this benefit has been archived, and no longer available for use |
tags ARRAY | An array of tags associated with the benefit |
is_claimable BOOLEAN | Denotes whether this benefit can be claimed by a customer, this is different to redeeming. See claiming benefits. |
max_global_redemptions INTEGER | The global maximum amount this benefit can be redeemed. |
total_global_redemptions_remaining INTEGER | The amount of global redemptions remaining for this definition |
total_global_redemptions INTEGER | The amount of times this benefit has been redeemed |
total_global_created INTEGER | The amount of times this benefit has been assigned to a profile |
claim_period_start_at STRING DATE-TIME | The start date when customers can begin claiming the benefit (if is_claimable is true) |
claim_period_end_at STRING DATE-TIME | The end date when customers can no longer claim the benefit (if is_claimable is true) |
claim_condition ARRAY | An array of attributes that must be available on the profile to be assigned. For example, the Tier must be level 2, or the Joined location must be specific. |
is_reclaimable BOOLEAN | Denotes whether this benefit can be reclaimed by the same profile, once already claimed. |
notify_schedule_offset INTEGER | Offset the calculated schedule time from offset_days, offset_hours. this value is subtracted from the scheduled time (in hours) |
notify_issue_offset_days INTEGER | An notification after the reward is issued Send X Days after the issue |
notify_issue_offset_hour INTEGER | Send at X Hour of the day |
notify_remind_offset_days INTEGER | An expiry reminder offset in days Send X Days after the end_date |
notify_remind_offset_hour INTEGER | Send at X Hour of the day |
notify_extend_offset_days INTEGER | An extension reminder usually sent before expiry Send X Days after the end_date |
notify_extend_offset_hour INTEGER | Send at X Hour of the day |
remind_target_id INTEGER | the target id used when an reminder notification is triggered |
extend_target_id INTEGER | the target id used when an extension notification is triggered |
issue_target_id INTEGER | the target id used when an issued notification is triggered |
end_at INTEGER | The end (or expiry) date of the definition |
total_allocations INTEGER | The total allocations for this benefit |
total_allocations_remaining INTEGER | The total allocations remaining for this benefit |
force_allocation BOOLEAN | If this flag is true, this benefit can only be assigned to a profile via an allocation. |
created_at STRING DATE-TIME | The UTC date & time the benefit record was created in ISO 8601 format. |
updated_at STRING DATE-TIME | The UTC date & time the benefit record was last updated in ISO 8601 format. |