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 an achievement?

Achievements are cumulative goals that customers reach by interacting with the brand in predetermined ways, and can be used to unlock Rewards and Benefits. Every achievement is made up of a count and achievement levels. Each level is achieved by reaching the levels count goal. A profile can hold multiple achievements at once.

Definitions

Achievements require a definition when being added to a profile. Achievement Definitions act as templates that can be used in the created of profile achievements, to specify the type of achievement being given.

Adding a Profile Achievement

To add an achievement, you’ll first need to have an Achievement Definition. Once this has been selected, specify the definition_id of your achievement definition when adding the profile achievement.
See Achievements for a full explanation of how achievement definitions, levels, and profile achievement instances work.

Achievement properties

AttributeDescription
definition_id INTEGERThe unique Omneo ID of the achievement definition you would like to use
count INTEGERThe amount of points you wish to add towards the achievement