> ## 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.

# 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](ref:targets) id used when an issued notification is triggered                                                                                                                     |
| expiry\_target\_id `INTEGER`     | the [target](ref:targets) id used when an expiry notification is triggered                                                                                                                     |
| notify\_issue\_offset `INTEGER`  | Issue notification offset in hours                                                                                                                                                             |
| notify\_expiry\_offset `INTEGER` | Expiry notification offset in hours                                                                                                                                                            |
| 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](/concepts/incentives/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.                                                                                                                |