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.
More information about benefits
Additional information about benefits can be found on the Omneo [helpcenter] (https://help.omneo.io/hc/en-au/articles/360000038395-Benefits)
Benefit definition properties
Attribute | Description |
|---|---|
id
| The unique Omneo ID of the definition |
name | The display name of the definition |
handle | The unique handle for the definition |
period | Valid for (in Days) |
description | The internal description for the definition |
internal_notes | Internal notes against this definition |
short_description | A publicly available short description for this definition |
long_description | A publicly available full HTML description for this definition |
terms_conditions | Terms and conditions attached to this condition |
redeem_instructions_store | Instructions to redeem in a physical store |
redeem_instructions_online | Instructions to redeem online |
redeem_code_pos | A redemption code used at the Point of Sale |
redeem_code_online | A redemption code used Online |
icon | A valid URL for the icon associated with this definition |
image_url | A valid URL for the cover image associated with this definition |
max_redemptions | The total redemptions available for an individual |
is_extendable | Denotes whether this definition's end date can be extended |
is_assignable | Denotes whether this definition can be assigned to an Omneo profile |
is_reassignable | Denotes whether this benefit can be reassigned once already assigned to a profile |
is_published | Denotes whether this benefit is published and is visible to the customer |
is_archived | Denotes whether this benefit has been archived, and no longer available for use |
tags | An array of tags associated with the benefit |
is_claimable | Denotes whether this benefit can be claimed by a customer, this is different to redeeming. |
max_global_redemptions | The global maximum amount this benefit can be redeemed. |
total_global_redemptions_remaining | The amount of global redemptions remaining for this definition |
total_global_redemptions | The amount of times this benefit has been redeemed |
total_global_created | The amount of times this benefit has been assigned to a profile |
claim_period_start_at | The start date when customers can begin claiming the benefit (if |
claim_period_end_at | The end date when customers can no longer claim the benefit (if |
claim_condition | An array of attributes that must be available on the profile to be assigned. |
is_reclaimable | Denotes whether this benefit can be reclaimed by the same profile, once already claimed. |
notify_schedule_offset | Offset the calculated schedule time from offset_days, offset_hours. |
notify_issue_offset_days | An notification after the reward is issued |
notify_issue_offset_hour | Send at X Hour of the day |
notify_remind_offset_days | An expiry reminder offset in days |
notify_remind_offset_hour | Send at X Hour of the day |
notify_extend_offset_days | An extension reminder usually sent before expiry |
notify_extend_offset_hour | Send at X Hour of the day |
remind_target_id | the target id used when an reminder notification is triggered |
extend_target_id | the target id used when an extension notification is triggered |
issue_target_id | the target id used when an issued notification is triggered |
end_at | The end (or expiry) date of the definition |
total_allocations | The total allocations for this benefit |
total_allocations_remaining | The total allocations remaining for this benefit |
force_allocation | If this flag is true, this benefit can only be assigned to a profile via an allocation. |
created_at | The UTC date & time the benefit record was created in ISO 8601 format. |
updated_at | The UTC date & time the benefit record was last updated in ISO 8601 format. |