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 |
|---|---|
idINTEGERREAD-ONLY | The unique Omneo ID of the definition |
nameSTRING | The display name of the definition |
handleSTRING | The unique handle for the definition |
periodINTEGER | Valid for (in Days) |
descriptionSTRING | The internal description for the definition |
internal_notesSTRING | Internal notes against this definition |
short_descriptionSTRING | A publicly available short description for this definition |
long_descriptionSTRING | A publicly available full HTML description for this definition |
terms_conditionsSTRING | Terms and conditions attached to this condition |
redeem_instructions_storeSTRING | Instructions to redeem in a physical store |
redeem_instructions_onlineSTRING | Instructions to redeem online |
redeem_code_posSTRING | A redemption code used at the Point of Sale |
redeem_code_onlineSTRING | A redemption code used Online |
iconURL | A valid URL for the icon associated with this definition |
image_urlURL | A valid URL for the cover image associated with this definition |
max_redemptionsINTEGER | The total redemptions available for an individual |
is_extendableBOOLEAN | Denotes whether this definition's end date can be extended |
is_assignableBOOLEAN | Denotes whether this definition can be assigned to an Omneo profile |
is_reassignableBOOLEAN | Denotes whether this benefit can be reassigned once already assigned to a profile |
is_publishedBOOLEAN | Denotes whether this benefit is published and is visible to the customer |
is_archivedBOOLEAN | Denotes whether this benefit has been archived, and no longer available for use |
tagsARRAY | An array of tags associated with the benefit |
is_claimableBOOLEAN | Denotes whether this benefit can be claimed by a customer, this is different to redeeming. Further information about claiming a benefit [here] (https://help.omneo.io/hc/en-au/articles/360001389876-Claim-Benefit-) |
max_global_redemptionsINTEGER | The global maximum amount this benefit can be redeemed. |
total_global_redemptions_remainingINTEGER | The amount of global redemptions remaining for this definition |
total_global_redemptionsINTEGER | The amount of times this benefit has been redeemed |
total_global_createdINTEGER | The amount of times this benefit has been assigned to a profile |
claim_period_start_atSTRINGDATE-TIME | The start date when customers can begin claiming the benefit (if is_claimable is true) |
claim_period_end_atSTRINGDATE-TIME | The end date when customers can no longer claim the benefit (if is_claimable is true) |
claim_conditionARRAY | 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_reclaimableBOOLEAN | Denotes whether this benefit can be reclaimed by the same profile, once already claimed. |
notify_schedule_offsetINTEGER | Offset the calculated schedule time from offset_days, offset_hours. this value is subtracted from the scheduled time (in hours) |
notify_issue_offset_daysINTEGER | An notification after the reward is issued Send X Days after the issue |
notify_issue_offset_hourINTEGER | Send at X Hour of the day |
notify_remind_offset_daysINTEGER | An expiry reminder offset in days Send X Days after the end_date |
notify_remind_offset_hourINTEGER | Send at X Hour of the day |
notify_extend_offset_daysINTEGER | An extension reminder usually sent before expiry Send X Days after the end_date |
notify_extend_offset_hourINTEGER | Send at X Hour of the day |
remind_target_idINTEGER | the target id used when an reminder notification is triggered |
extend_target_idINTEGER | the target id used when an extension notification is triggered |
issue_target_idINTEGER | the target id used when an issued notification is triggered |
end_atINTEGER | The end (or expiry) date of the definition |
total_allocationsINTEGER | The total allocations for this benefit |
total_allocations_remainingINTEGER | The total allocations remaining for this benefit |
force_allocationBOOLEAN | If this flag is true, this benefit can only be assigned to a profile via an allocation. |
created_atSTRINGDATE-TIME | The UTC date & time the benefit record was created in ISO 8601 format. |
updated_atSTRINGDATE-TIME | The UTC date & time the benefit record was last updated in ISO 8601 format. |