Loyalty Management Developer Guide
jLoyaltyTier
You can set up Loyalty Tiers to group the members based on their qualifying points. Qualifying points are awarded to members based on their activities in a loyalty program. The hierarchies are created in the tiers using the sequence number. The qualifying points are used to assess a member’s tier for upgrade or downgrade.
Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields
Color
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The color that represents the tier. This field is available in API version 62.0 and later.
Description
Type: textarea
Properties: Create, Filter, Nillable, Sort, Update
Description: Detailed description of the tier.
EligibleEnrollmentType
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The type of enrollment for which a member is eligible.
Possible values are:
- Free
- Paid
- SegmentBased
- TierBased
- Trial
LastReferencedDate
Type: dateTime
Properties: Filter, Nillable, Sort
Description: The most recent date on which a user referenced this record.
LastViewedDate
Type: dateTime
Properties: Filter, Nillable, Sort
Description: The most recent date on which a user viewed this record.
LoyaltyProgramId
Type: reference
Properties: Filter, Group, Nillable, Sort
Description: The ID of the loyalty program associated with the loyalty tier. This field is available in API version 64.0 and later.
This field is a relationship field.
Relationship Name: LoyaltyProgram
Refers To: LoyaltyProgram
LoyaltyTierGroupId
Type: reference
Properties: Create, Filter, Group, Sort
Description: ID of the loyalty tier group.
This is a relationship field.
Relationship Name: LoyaltyTierGroup
Relationship Type: Lookup
Refers To: LoyaltyTierGroup
MaximumEligibleBalance
Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The maximum balance that's required for loyalty program members to be eligible for the tier. This field is available in API version 58.0 and later.
MinimumEligibleBalance
Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The minimum balance that's required for loyalty program members to be eligible for the tier. This field is available in API version 58.0 and later.
Name
Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: The name of the loyalty tier.
SequenceNumber
Type: int
Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
Description: The sequence number indicates the ranking of the tier. The tier with the highest sequence number indicates the highest tier.
Associated Objects
This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.
LoyaltyTierChangeEvent (API Version 62.0): Change events are available for the object.
LoyaltyTierHistory: History is available for tracked fields of the object.