Loyalty Management Developer Guide
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Loyalty Management Data Model
Loyalty Clubs Data Model
AnalyticsDatasetDefinition
Benefit
BenefitParameterValue
BenefitType
BusinessLimitPendingTrxn
BusinessLimitSpecification
BusinessLimitTracker
DigitalPass
DigitalPassTemplate
DigitalPassTmplParameter
GameDefinition
GameParticipant
GameParticipantReward
GameReward
JournalReason
JournalSubType
JournalType
LoyaltyAggrPointExprLedger
LoyaltyLedger
LoyaltyLedgerTraceability
LoyaltyMemberCurrency
LoyaltyMembershipLifecycle
LoyaltyMemberTier
LoyaltyPartnerProduct
LoyaltyPgmCurrencyExtPrd
LoyaltyPgmCurrencySubtype
LoyaltyPgmEngmtAttribute
LoyaltyPgmEngmtAttrProm
LoyaltyPgmGroupMbrRlnsp
LoyaltyPgmMbrAttributeVal
LoyaltyPgmMbrLinkedPtnr
LoyaltyPgmMbrPromEligView
LoyaltyPgmPartnerCurrency
LoyaltyPgmPartnerPromotion
LoyaltyPgmPtnrLdgrSummary
LoyaltyPgmPtnrPrepaidPack
LoyaltyProgram
LoyaltyProgramBadge
LoyaltyProgramCurrency
LoyaltyProgramCurrencyTier
LoyaltyProgramJournalType
LoyaltyProgramMbrPromotion
LoyaltyProgramMember
LoyaltyProgramMemberBadge
LoyaltyProgramMemberCase
LoyaltyProgramMemberMerge
LoyaltyProgramPartner
LoyaltyProgramPartnerLedger
LoyaltyProgramProcess
LoyaltyProgramWidget
LoyaltyTier
LoyaltyTierBenefit
LoyaltyTierEligibilitySrc
LoyaltyTierGroup
LoyaltyTierMshpFeeOption
LoyaltyTierPromotion
MemberBenefit
NetworkReferencedObject
Promotion
PromotionActionableList
PromotionChannel
PromotionExecutionEvalGrp
PromotionExecEvalGrpItem
PromotionLimit
PromotionLimitUsage
PromotionLoyaltyPtnrProdt
PromotionMarketSegment
PromotionPartyUsage
PromotionPartyUsageDetail
PromotionProduct
PromotionProductCategory
PromotionRuleTemplate
PromotionStage
PromotionStageEmailTemplate
TransactionJournal
Voucher
VoucherDefinition
Coupon Objects in Loyalty Management
StandardValueSet Names and Standard Picklist Fields for Loyalty Management
Loyalty Management Standard Objects
Loyalty Management data model provides objects and fields to create and manage loyalty
programs for your organization. Use the objects to manage partners and members, track members'
activities, reward members, and manage promotions.
In addition to the standard objects included with the Loyalty Management license, the standard objects included with the Salesforce platform licenses enabled in your Org are available out-of-the-box.
When you customize standard fields, we recommend that you don’t change the API names of the default picklist values.
Warning
-
Loyalty Management Data Model
Learn about the objects and relationships within the Loyalty Management data model. -
Loyalty Clubs Data Model
Clubs are interest-based membership initiatives designed to provide exclusive benefits and privileges to customers. -
AnalyticsDatasetDefinition
Represents the datasets used for analytics, such as those in CRM Analytics and Tableau. This object is available in API version 65.0 and later. -
Benefit
Represents information about benefits associated with the loyalty program. Benefits are mapped to the members based on the tier or other program rules. This object is available in API version 51.0 and later. -
BenefitParameterValue
Represents the runtime value of a parameter that's used when executing a flow for benefit action. This object is available in API version 52.0 and later. -
BenefitType
Represents information about the type of benefits such as Support Benefits available to the loyalty program member. This object is available in API version 51.0 and later. -
BusinessLimitPendingTrxn
Represents transient usage records that reserve a portion of the business limit for a transaction. If the transaction fails, these reserved portions are freed up for future use. This object is available in API version 67.0 and later. -
BusinessLimitSpecification
Represents a business limit and its metadata, including the context definition that maps a limit record to the limit framework. This object is available in API version 67.0 and later. -
BusinessLimitTracker
Represents a specific business limit instance that tracks the current usage. This object is available in API version 67.0 and later. -
DigitalPass
Represents a user-facing representation generated from a digital pass template. It contains specific, relevant data, such as a membership number or voucher details, making each pass unique to the user. This pass can be optionally stored in a mobile or digital wallet. This object is available in API version 66.0 and later. -
DigitalPassTemplate
Represents a template for creating digital passes, such as loyalty membership cards or coupons. It outlines the pass's design, data fields, and functionality, enabling the generation of multiple unique passes from a single, reusable template. This object is available in API version 66.0 and later. -
DigitalPassTmplParameter
Represents a specific, configurable data field within a digital pass template. It defines the content type such as text, date, or image, and properties such as label and visibility, for a particular section of the pass. This object is available in API version 66.0 and later. -
GameDefinition
Represents information about a game that the loyalty program offers to its members. This object is available in API version 60.0 and later. -
GameParticipant
Represents a junction between a game definition and a participant who is either an account, a contact, or a loyalty program member. This object is available in API version 60.0 and later. -
GameParticipantReward
Represents the reward that’s provided to a participant after they’ve played a game. This object is available in API version 60.0 and later. -
GameReward
The reward that’s offered to participants of a game. This object is available in API version 60.0 and later. -
JournalReason
Represents a view that specifies the reason for the action that created a transaction journal. This object is available in API version 51.0 and later. -
JournalSubType
Represents the subcategory of transaction journal. This object is available in API version 51.0 and later. -
JournalType
Represents the category of transactions. For example: accrual, redemption. This object is available in API version 51.0 and later. -
LoyaltyAggrPointExprLedger
Represents information about non-qualifying currency points that expire based on a fixed model tier group. This object is available in API version 54.0 and later. -
LoyaltyLedger
Records the points that have been credited or debited for a member across the transactions. This object is available in API version 51.0 and later. -
LoyaltyLedgerTraceability
Represents a tracker for the loyalty ledger. The debit ledger consumes points from the linked credit ledger for a member redemption or an accrual cancellation. This object is available in API version 62.0 and later. -
LoyaltyMemberCurrency
Represents the information about point balance for a member and a particular currency. This object is available in API version 51.0 and later. -
LoyaltyMembershipLifecycle
Represents information about a member's lifecycle in the loyalty program. This object is available in API version 57.0 and later. -
LoyaltyMemberTier
Represents information about the current tier of the member across tier groups. This object is available in API version 51.0 and later. -
LoyaltyPartnerProduct
Represents products and product categories offered by loyalty partners. This object is available in API version 51.0 and later. -
LoyaltyPgmCurrencyExtPrd
Represents an additional timeframe beyond the standard expiration date for redeeming or reinstating points. It enables tier-based flexibility, allowing certain members more time to utilize their points before they are forfeited. This object is available in API version 67.0 and later. -
LoyaltyPgmCurrencySubtype
Represents a subtype of a fixed-model non-qualifying loyalty program currency. This object is available in API version 61.0 and later. -
LoyaltyPgmEngmtAttribute
Represents information about an engagement attribute for a loyalty program. This object is available in API version 55.0 and later. -
LoyaltyPgmEngmtAttrProm
Represents a junction between Loyalty Program Engagement Attribute and Promotion. Associate an engagement attribute with a promotion if you want to track the engagement attribute during the promotion period. This object is available in API version 55.0 and later. -
LoyaltyPgmGroupMbrRlnsp
Represents a junction between a Corporate or Individual type loyalty program member who is part of a group and the Group type loyalty program member. This object is available in API version 53.0 and later. -
LoyaltyPgmMbrAttributeVal
Represents information about the value reached by a loyalty program member for an engagement attribute. This object is available in API version 55.0 and later. -
LoyaltyPgmMbrLinkedPtnr
Represents the association between a loyalty program member and their membership with a partner. It acts as an association that facilitates points accrual and data exchange in a joint loyalty program. This object is available in API version 66.0 and later. -
LoyaltyPgmMbrPromEligView
Represents a virtual object that provides a consolidated view of the loyalty program member’s eligibility for a promotion and their enrollment status in eligible promotions. This object is available in API version 56.0 and later. -
LoyaltyPgmPartnerCurrency
Represents a junction between a loyalty program partner and a loyalty program currency. This object is available in API version 55.0 and later. -
LoyaltyPgmPartnerPromotion
Represents a junction between the Promotion and Loyalty Program Partner objects. This object is available in API version 55.0 and later. -
LoyaltyPgmPtnrLdgrSummary
Represents the aggregated ledger used by a loyalty program to credit points to or debit points from a prepaid partner's points pack. This ledger can also be used to add or deduct the monetary value of points from the postpaid partner's bill. This object is available in API version 55.0 and later. -
LoyaltyPgmPtnrPrepaidPack
Represents information about a prepaid set of points purchased by a loyalty program partner. This object is available in API version 55.0 and later. -
LoyaltyProgram
Represents the loyalty program within an organization. All the information related to members, tiers, tier groups, program currencies, vouchers, benefits, partners, promotions, transactions are associated with the program. This object is available in API version 51.0 and later. -
LoyaltyProgramBadge
Represents information about the badge that's associated with a loyalty program. This object is available in API version 56.0 and later. -
LoyaltyProgramCurrency
Represents qualifying and non-qualifying currencies associated with the program. Qualifying currency represents the engagement of a member with the program and it’s associated with a tier group. Non-qualifying currency represent the points that the member earns for redemption. This object is available in API version 51.0 and later. -
LoyaltyProgramCurrencyTier
Repesents a junction between non-qualifying loyalty program currency and loyalty tier. This object is available in API version 61.0 and later. -
LoyaltyProgramJournalType
Represents an activity that resets points validity for currencies with an activity-based expiration model. This object is available in API version 67.0 and later. -
LoyaltyProgramMbrPromotion
Represents details about the promotions to be applied for a loyalty program member. Tracks the enrollment status, promotion status, and progress for a promotion of a member. This object is available in API version 51.0 and later. -
LoyaltyProgramMember
Represents information about member who belongs to a loyalty program. The member can be individual or corporate type. This object is available in API version 51.0 and later. -
LoyaltyProgramMemberBadge
Represents a badge that’s assigned to a loyalty program member. This object is available in API version 56.0 and later. -
LoyaltyProgramMemberCase
Represents a junction between a loyalty program member and a case. This object is available in API version 52.0 and later. -
LoyaltyProgramMemberMerge
Represents information about merged loyalty program memberships. This object is available in API version 56.0 and later. -
LoyaltyProgramPartner
Represents partners that are associated with a given loyalty program. Partners can be an accrual partner, a redemption partner, or both. This object is available in API version 51.0 and later. -
LoyaltyProgramPartnerLedger
Represents the ledger used by a loyalty program to credit points to or debit points from a prepaid partner's points pack or from a postpaid partner’s point balance. This ledger can also be used to add or deduct the monetary value of points from the partner's postpaid bill. This object is available in API version 55.0 and later. -
LoyaltyProgramProcess
Represents information about loyalty program processes that determine how transaction journals are processed. This object is available in API version 54.0 and later. -
LoyaltyProgramWidget
Represents the configuration of a widget that a user can apply to the out-of-the-box widget templates and FlexCards provided by Omnistudio. The configuration helps implement custom UI changes, such as promotion type, promotion tag line, and so on for a user. This object is available in API version 57.0 and later. -
LoyaltyTier
Represents information about tiers of a loyalty program. A tier group has a set of tiers in a sequential order. This object is available in API version 51.0 and later. -
LoyaltyTierBenefit
A junction object that associates the loyalty benefits with the loyalty program tiers. This object is available in API version 51.0 and later. -
LoyaltyTierEligibilitySrc
Represents the customer groups that are eligible for club membership. This object is available in API version 64.0 and later. -
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. -
LoyaltyTierMshpFeeOption
Represents the options by which members can pay for tier or club memberships. This object is available in API version 63.0 and later. -
LoyaltyTierPromotion
Represents a junction between a member tier and a loyalty promotion. This object is available in API version 63.0 and later. -
MemberBenefit
Represents details about a benefit that’s assigned to a loyalty program member and has a benefit action that’s triggered. This object is available in API version 51.0 and later. -
NetworkReferencedObject
A junction object that associates the loyalty program with the Experience Cloud site. This object is available in API version 51.0 and later. -
Promotion
Represents a promotion associated with the loyalty program. It captures the information such as type of the promotion, issue of a voucher or credit points, promotion enrollment, and status of the promotion. This object is available in API version 51.0 and later. -
PromotionActionableList
Represent of a junction between a promotion and an actionable list. This object is available in API version 62.0 and later. -
PromotionChannel
Represents a promotion’s eligible channel. This object is available in API version 60.0 and later. -
PromotionExecutionEvalGrp
Represents a collection of promotions that are evaluated for execution as a group. This object is available in API version 65.0 and later. -
PromotionExecEvalGrpItem
Represents either a promotion or a promotion group in a promotion execution evaluation group. This object is available in API version 65.0 and later. -
PromotionLimit
Represents the limit of a promotion. This object is available in API version 60.0 and later. -
PromotionLimitUsage
Represents information about the total usage of a promotion limit. This object is available in API version 60.0 and later. -
PromotionLoyaltyPtnrProdt
Represents a relationship between a promotion and a loyalty partner product. It indicates the products or product categories that are applied to a particular promotion. This object is available in API version 51.0 and later. -
PromotionMarketSegment
Represents a relationship between a promotion and Data Cloud segment. It indicates the segments targeted for a particular promotion. This object is available in API version 51.0 and later. -
PromotionPartyUsage
Represents the details of number of times a promotion has been used by a customer. This object is available in API version 60.0 and later. -
PromotionPartyUsageDetail
Represents the amount that's discounted by a promotion for a transaction journal. This object is available in API version 60.0 and later. -
PromotionProduct
Represents a junction between a promotion and an product that’s eligible for the promotion. This object is available in API version 60.0 and later. -
PromotionProductCategory
Represents a junction between a promotion and an product category that’s eligible for the promotion. This object is available in API version 60.0 and later. -
PromotionRuleTemplate
Represents the configuration of a promotion rule template. This object is available in API version 60.0 and later. -
PromotionStage
Represents a stage when the promotion sends an email to the promotion's target audience. With Global Promotions Management, a promotion launch email is sent after the promotion is activated. This object is available in API version 60.0 and later. -
PromotionStageEmailTemplate
Represents a junction between a promotion stage and an email template. With Global Promotions Management, a promotion's launch email is associated with the promotion's Promotion Launched stage. You can customize the promotion launch email based on your company’s branding. This object is available in API version 60.0 and later. -
TransactionJournal
Represents information about loyalty transactions that track activities, member behavior, and adjustments. This object is available in API version 51.0 and later. -
Voucher
Represents details about a voucher that's issued to a loyalty program member. This object is available in API version 51.0 and later. -
VoucherDefinition
Represents details about a voucher definition that’s associated with a loyalty program. This object is available in API version 51.0 and later.