Referral Marketing Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Introduction to Referral Marketing
Objects for B2B and B2C Referral Programs
CommunicationChannelTemplate
CommunicationChannelType
ExtendedReward
ExtendedRewardDefinition
InternalOrgUnitCommChannel
JournalSubType
JournalType
LoyaltyPgmEngmtAttribute
LoyaltyPgmMbrAttributeVal
LoyaltyProgram
LoyaltyProgramMbrPromotion
LoyaltyProgramMember
LoyaltyProgramProcess
LoyaltyProgramProcessRule
LoyaltyProgramWidget
Promotion
PromotionMarketSegment
PromotionStage
PromStageCommChannelTmpl
PromotionStageEmailTemplate
PromotionStageTemplate
PromotionTemplate
PromTmplExtdRewardDef
Referral
TransactionJournal
Voucher
VoucherDefinition
Standard Objects
The Referral Marketing and B2B Referral Management data models come with a set of
objects and fields to manage referral program information such as program design, advocate
and referral details, and rewards. Developers can extend the objects in the data model based
on your company’s requirements.
-
Objects for B2B and B2C Referral Programs
Objects form the data model foundation for managing referral program information. Discover which objects are available for B2B and B2C referral programs. -
CommunicationChannelTemplate
Represents the template for different communication channels. This object is available in API version 63.0 and later. This object is available only for B2C referral programs. -
CommunicationChannelType
Represents the type of communication channel such as WhatsApp, SMS, or Telegram. This object is available in API version 63.0 and later. This object is available only for B2C referral programs. -
ExtendedReward
Represents the instance of an extended reward that's issued to a customer, a partner, or a member. This object is available in API version 64.0 and later. -
ExtendedRewardDefinition
Represents the definition of an extended reward that is associated with a loyalty program. This object is available in API version 64.0 and later. -
InternalOrgUnitCommChannel
Represents the communication channel for the internal organization unit. This object is available in API version 63.0 and later. This object is available only for B2C referral programs. -
JournalSubType
Represents a subcategory of transaction journals. Journal subtypes identify the type of advocate or referred party activity for which transaction journals are created. This object is available in API version 59.0 and later. -
JournalType
Represents a category of transaction journal. Journal types identify the reason for which transaction journals are created. This object is available in API version 59.0 and later. -
LoyaltyPgmEngmtAttribute
Represents an event that’s tracked for advocates. For example, engagement attributes are used to track the number of times advocates have referred their friends or businesses in a day and the number of times advocates have been rewarded for successful referrals. This object is available in API version 59.0 and later. -
LoyaltyPgmMbrAttributeVal
Represents an advocate’s progress towards to target of an engagement attribute. This object is available in API version 49.0 and later. -
LoyaltyProgram
Represents the referral program. All records related to the referral program’s promotions, rewards, advocates, and referrals are associated with the referral program. This object is available in API version 59.0 and later. -
LoyaltyProgramMbrPromotion
Represents a junction between an advocate and a promotion and is used to track whether an advocate has signed up for a promotion. This object is available in API version 49.0 and later. -
LoyaltyProgramMember
Represents the details of a referral program advocate. This object is available in API version 59.0 and later. -
LoyaltyProgramProcess
Represents information about a process that processes transaction journals for a referral promotion’s advocates and their referred party’s referral events. This object is available in API version 59.0 and later. -
LoyaltyProgramProcessRule
Represents the details of a rule in a loyalty program process. This object is available in API version 59.0 and later. -
LoyaltyProgramWidget
Represents information about a widget that advocates use to enroll in the referral program and refer their friends This object is available in API version 59.0 and later. This object is available only for B2C referral programs. -
Promotion
Represents information about a referral promotion. This object is available in API version 59.0 and later. -
PromotionMarketSegment
Represents a junction between a promotion and a Data Cloud segment. Associate a promotion with a segment when you want only the contacts associated with the segment to join as advocates of the referral promotion. This object is available in API version 59.0 and later. This object is available only for B2C referral programs. -
PromotionStage
Represents a stage in a referral promotion. This object is available in API version 59.0 and later. -
PromStageCommChannelTmpl
Represents a junction between promotion stage and communication channel template. This object is available in API version 63.0 and later. This object is available only for B2C referral programs. -
PromotionStageEmailTemplate
Represents a junction between a promotion stage and an email template. When a referral promotion is created, an email template is associated with each stage of the promotion. You can customize the email template for each stage based on your company’s branding. This object is available in API version 59.0 and later. This object is available only for B2C referral programs. -
PromotionStageTemplate
Represents the reuseable configuration details of a promotion stage template. This object is available in API version 61.0 and later. -
PromotionTemplate
Represents the JSON configuration and details of a referral promotion template. This object is available in API version 61.0 and later. -
PromTmplExtdRewardDef
Represents a junction between promotion template and extended reward definition. This object is available in API version 64.0 and later. -
Referral
Represents the details of a referral submitted by an advocate. This object is available in API version 59.0 and later. -
TransactionJournal
Represents the details of an advocate or their referred party's activity. This object is available in API version 49.0 and later. -
Voucher
Represents the details of a voucher that’s issued to an advocate or to a referred friend. This object is available in API version 59.0 and later. -
VoucherDefinition
Represents information about the voucher template. A voucher definition is used to issue vouchers to advocates and their referred parties. This object is available in API version 59.0 and later.