Newer Version Available

This content describes an older version of this product. View Latest

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

Field Details
Description
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
Detailed description of the tier group.
ExtendExpiration
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
The field decides if the tier is changed on the exact day or the last day of the month.
Possible values are:
  • MemberEnrollmentAnniversary
  • None
  • QualifyingPointsResetDate
  • TillEndOfMonth
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the loyalty tier group is active.
IsHiddenToMembers
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the loyalty tier group is hidden.
IsPrimary
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the loyalty tier group is primary.
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.
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
Start date of the QP reset process.
QpResetFrequency
Type
int
Properties
Create, Filter, Group, Sort, Update
Description
The frequency in which the QP reset job is run.
QpResetPeriod
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Unit of the period for QP reset.
Possible values are:
  • Days
  • Months
  • Years
TierModel
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
It’s the model that decides the start date of the qualifying period.
Possible values are:
  • Anniversary
  • Fixed
TierPeriodQuantity
Type
int
Properties
Create, Filter, Group, Sort, Update
Description
The period after which tier assessment for a member is done.
TierPeriodUnit
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The frequency type for the tier assessment.
Possible values are:
  • Days
  • Months
  • Years