Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

​
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

AttributeDescription
id INTEGER READ-ONLYThe unique Omneo ID of the definition
name STRINGThe display name of the definition
handle STRINGThe unique handle for the definition
period INTEGERValid for (in Days)
description STRINGThe internal description for the definition
internal_notes STRINGInternal notes against this definition
short_description STRINGA publicly available short description for this definition
long_description STRINGA publicly available full HTML description for this definition
terms_conditions STRINGTerms and conditions attached to this condition
redeem_instructions_store STRINGInstructions to redeem in a physical store
redeem_instructions_online STRINGInstructions to redeem online
redeem_code_pos STRINGA redemption code used at the Point of Sale
redeem_code_online STRINGA redemption code used Online
icon URLA valid URL for the icon associated with this definition
image_url URLA valid URL for the cover image associated with this definition
max_redemptions INTEGERThe total redemptions available for an individual
is_extendable BOOLEANDenotes whether this definition’s end date can be extended
is_assignable BOOLEANDenotes whether this definition can be assigned to an Omneo profile
is_reassignable BOOLEANDenotes whether this benefit can be reassigned once already assigned to a profile
is_published BOOLEANDenotes whether this benefit is published and is visible to the customer
is_archived BOOLEANDenotes whether this benefit has been archived, and no longer available for use
tags ARRAYAn array of tags associated with the benefit
is_claimable BOOLEANDenotes whether this benefit can be claimed by a customer, this is different to redeeming. See claiming benefits.
max_global_redemptions INTEGERThe global maximum amount this benefit can be redeemed.
total_global_redemptions_remaining INTEGERThe amount of global redemptions remaining for this definition
total_global_redemptions INTEGERThe amount of times this benefit has been redeemed
total_global_created INTEGERThe amount of times this benefit has been assigned to a profile
claim_period_start_at STRING DATE-TIMEThe start date when customers can begin claiming the benefit (if is_claimable is true)
claim_period_end_at STRING DATE-TIMEThe end date when customers can no longer claim the benefit (if is_claimable is true)
claim_condition ARRAYAn 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 BOOLEANDenotes whether this benefit can be reclaimed by the same profile, once already claimed.
notify_schedule_offset INTEGEROffset the calculated schedule time from offset_days, offset_hours. this value is subtracted from the scheduled time (in hours)
notify_issue_offset_days INTEGERAn notification after the reward is issued Send X Days after the issue
notify_issue_offset_hour INTEGERSend at X Hour of the day
notify_remind_offset_days INTEGERAn expiry reminder offset in days Send X Days after the end_date
notify_remind_offset_hour INTEGERSend at X Hour of the day
notify_extend_offset_days INTEGERAn extension reminder usually sent before expiry Send X Days after the end_date
notify_extend_offset_hour INTEGERSend at X Hour of the day
remind_target_id INTEGERthe target id used when an reminder notification is triggered
extend_target_id INTEGERthe target id used when an extension notification is triggered
issue_target_id INTEGERthe target id used when an issued notification is triggered
end_at INTEGERThe end (or expiry) date of the definition
total_allocations INTEGERThe total allocations for this benefit
total_allocations_remaining INTEGERThe total allocations remaining for this benefit
force_allocation BOOLEANIf this flag is true, this benefit can only be assigned to a profile via an allocation.
created_at STRING DATE-TIMEThe UTC date & time the benefit record was created in ISO 8601 format.
updated_at STRING DATE-TIMEThe UTC date & time the benefit record was last updated in ISO 8601 format.