Loyalty Management Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Loyalty Management Standard Objects
Loyalty Management Data Model
Benefit
BenefitParameterValue
BenefitType
GameDefinition
GameParticipant
GameParticipantReward
GameReward
JournalReason
JournalSubType
JournalType
LoyaltyAggrPointExprLedger
LoyaltyLedger
LoyaltyLedgerTraceability
LoyaltyMemberCurrency
LoyaltyMembershipLifecycle
LoyaltyMemberTier
LoyaltyPartnerProduct
LoyaltyPgmCurrencySubtype
LoyaltyPgmEngmtAttribute
LoyaltyPgmEngmtAttrProm
LoyaltyPgmGroupMbrRlnsp
LoyaltyPgmMbrAttributeVal
LoyaltyPgmMbrPromEligView
LoyaltyPgmPartnerCurrency
LoyaltyPgmPartnerPromotion
LoyaltyPgmPtnrLdgrSummary
LoyaltyPgmPtnrPrepaidPack
LoyaltyProgram
LoyaltyProgramBadge
LoyaltyProgramCurrency
LoyaltyProgramCurrencyTier
LoyaltyProgramMbrPromotion
LoyaltyProgramMember
LoyaltyProgramMemberBadge
LoyaltyProgramMemberCase
LoyaltyProgramMemberMerge
LoyaltyProgramPartner
LoyaltyProgramPartnerLedger
LoyaltyProgramProcess
LoyaltyProgramWidget
LoyaltyTier
LoyaltyTierBenefit
LoyaltyTierGroup
MemberBenefit
NetworkReferencedObject
Promotion
PromotionActionableList
PromotionChannel
PromotionLimit
PromotionLimitUsage
PromotionLoyaltyPtnrProdt
PromotionMarketSegment
PromotionPartyUsage
PromotionPartyUsageDetail
PromotionProduct
PromotionProductCategory
PromotionRuleTemplate
PromotionStage
PromotionStageEmailTemplate
TransactionJournal
Voucher
VoucherDefinition
Loyalty Management Fields on Standard Objects
Coupon Objects in Loyalty Management
Loyalty Management Associated Objects
Apex Reference
Loyalty Management Business APIs
Loyalty Management Standard Invocable Actions
Loyalty Management Custom Invocable Actions
Loyalty Management Metadata API Types
Loyalty Management Tooling API Objects
Loyalty Management Mobile SDK
Gamification Mobile SDK
Data Processing Engine, Batch Management, and Monitor Workflow Services
PDF

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.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
Description
Type
string
Properties
Create, Filter, Nillable, Sort, Update
Description
Description of the loyalty program.
EscrowPeriod
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of days after which the escrow points are credited to the existing points balance. This field is available in API version 53.0 and later.
IsPrimary
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether a loyalty program is the primary program.
The default value is 'false'. This field is available in API version 52.0 and later.
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.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Required. The name of the loyalty program. The name must contain at least one alphanumeric character.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the owner of this record.
This is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Required. The status of the loyalty program.
Possible values are:
  • Active
  • Inactive

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.

LoyaltyProgramChangeEvent (API Version 62.0)
Change events are available for the object.
LoyaltyProgramFeed
Feed tracking is available for the object.
LoyaltyProgramHistory
History is available for tracked fields of the object.
LoyaltyProgramOwnerSharingRule
Sharing rules are available for the object.
LoyaltyProgramShare
Sharing is available for the object.