LoyaltyTierGroup Represents information about tier groups of a loyalty program. Tier group categorizes members based on their loyalty points. This object is available in API version 51.0 and later.
Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields
Category
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The category of the loyalty tier group.
Possible values are:
ClubsTier_Group - Tier Group
Description
Type: textarea
Properties: Create, Filter, Nillable, Sort, Update
Description: Detailed description of the tier group.
EndDate
Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The end date of the loyalty tier group.
ExtendExpiration
Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Required. The field decides if the tier is changed on the exact day or the last day of the month.
Possible values are:
MemberEnrollmentAnniversary— Select this option only when TierModel is Anniversary. This change is available from API version 52.0 and later.NoneQualifyingPointsResetDate— This value can only be selected when TierModel is Fixed. This change is available from API version 52.0 and later.TillEndOfMonth— This value isn’t supported in API version 52.0 and later.
IsActive
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Required. Indicates whether the loyalty tier group is active (true) or not (false).
IsHiddenToMembers
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the loyalty tier group is hidden (true) or not (false).
IsPrimary
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the loyalty tier group is primary (true) or not (false).
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: Create, Filter, Group, Sort
Description: ID of the loyalty program.
This is a relationship field.
Relationship Name: LoyaltyProgram
Relationship Type: Master-detail
Refers To: LoyaltyProgram
Name
Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: The name of the loyalty tier group.
QpResetDate
Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Required. Start date of the QP reset process.
QpResetFrequency
Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Required. The frequency at which members’ qualifying points must be reset.
QpResetPeriod
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Required. Unit of the period for QP reset.
Possible values are:
Days—This value isn’t supported in API version 52.0 and later.Months— This value isn’t supported in API version 52.0 and later.Years
StartDate
Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The start date of the loyalty tier group.
TierAssessmentCurrencyId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the Loyalty Program Currency that’s used to assess and assign tiers to members of the loyalty program. Members are assigned tiers based on their points balance for the currency. This field is available in API version 58.0 and later.
This field is a relationship field.
Relationship Name: TierAssessmentCurrency
Relationship Type: Lookup
Refers To: LoyaltyProgramCurrency
TierModel
Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Required. It’s the model that decides the start date of the qualifying period.
Possible values are:
TierPeriodQuantity
Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Required. The period after which members’ tier must be reset.
TierPeriodUnit
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Required. The frequency type for the tier assessment.
Possible values are:
Days—This value isn’t supported in API version 52.0 and later.MonthsYears
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.
LoyaltyTierGroupChangeEvent (API Version 62.0):
j