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.

Profile Tier informationA tier definition contains data unique to each individual tier. To review profile data in relation to the associated tiers, you can review Read Profile Tier

Tier definition properties

AttributeDescription
id STRING READ-ONLYthe ID of the tier
name STRINGThe name of the tier
handle STRINGA unique handle for the tier
is_floor BOOLEANDenotes whether this tier is the lowest tier the profile can achieve
value_min INTEGERThe minimum amount of points needed to achieve this tier
value_maintain INTEGERThe points needed to be achieved to maintain this tier by the next tier anniversary
is_assignable BOOLEANDenotes whether this tier is assignable to the current member profile
internal_notes STRINGInternal notes made against the tier
description STRINGThe basic description for the tier
short_description STRINGA short description about the current tier
long_description STRINGA long description for the tier in HTML markup.
terms_conditions STRINGThe terms and conditions for the tier
icon STRING URLA URL for the desired icon for this tier
image_url STRING URLA URL for the desired cover image for this tier
earn_instructions STRINGinstructions on earning this tier
tags ARRAYTags associated with this tier
created_at DATE-TIME READ-ONLYThe date and time this tier was created
updated_at DATE-TIME READ-ONLYThe date and time this tier was last updated