Reward Definitions

What is a reward definition?

A reward definition is a configurable template, containing core information used when assigning a reward. To redeem a reward against a profile, you first need to specify the definition of the reward you are assigning. For example, you may have a “Birthday” reward definition, and a “Christmas” reward definition. When attributing the reward to a profile, you can specify your desired definition at the time of redemption.

Reward definition properties

Attribute	Description
id `INTEGER`	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
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
earn_instructions `STRING`	Instructions to customers on how to earn this reward
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
issue_target_id `INTEGER`	The target id used when an issued notification is triggered
expiry_target_id `INTEGER`	The target id used when an expiry notification is triggered
remind_target_id `INTEGER`	The target id used when a reminder notification is triggered
extend_target_id `INTEGER`	The target id used when an extension notification is triggered
notify_issue_offset_days `INTEGER`	Send a notification X days after the reward is issued
notify_issue_offset_hour `INTEGER`	Send at X hour of the day
notify_remind_offset_days `INTEGER`	Send an expiry reminder X days before the `end_date`. Required when `expiry_target_id` or `notify_remind_offset_hour` is set.
notify_remind_offset_hour `INTEGER`	Send at X hour of the day. Required when `expiry_target_id` or `notify_remind_offset_days` is set.
notify_extend_offset_days `INTEGER`	Send an extension notification X days before the `end_date`. Required when `extend_target_id` or `notify_extend_offset_hour` is set.
notify_extend_offset_hour `INTEGER`	Send at X hour of the day. Required when `extend_target_id` or `notify_extend_offset_days` is set.
internal_notes `STRING`	Internal notes attached to this definition
type `STRING` `ENUM`	The type of the reward definition available values are: - activation - anniversary - birthday - bonus - campaign - customer-service - reactivation - spend - staff - system-adjustment - other
value `FLOAT`	The value of the reward
is_extendable `BOOLEAN`	Denotes if this definition can be extended past the expiry date
is_assignable `BOOLEAN`	Denotes whether this definition can be allocated to a profile. Further information about assigning reward can be found in Rewards
is_reassignable `BOOLEAN`	Denotes whether this definition can be allocated to a profile when already allocated
is_published `BOOLEAN`	Denotes whether this definition is published and is visible to the customer
tags `ARRAY`	An Array of tags attached to this definition
created_at `STRING` `DATE-TIME`	The UTC date & time the definition record was created in ISO 8601 format.
updated_at `STRING` `DATE-TIME`	The UTC date & time the benefit definition was last updated in ISO 8601 format.

Overview

Authentication

Profiles

Commerce

Incentives

Lists

Groups

Ratings and Interactions

Reactions

Organisations and access

Configuration

Platform

Questionnaires

Reward Definitions

What is a reward definition?

Reward definition properties

​What is a reward definition?

​Reward definition properties

What is a reward definition?

Reward definition properties