Referral Marketing Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Introduction to Referral Marketing
Referral Marketing Standard Objects
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
Referral Marketing Fields on Standard Objects
Referral Marketing Associated Objects
Referral Marketing Business APIs
Referral Marketing Standard Invocable Actions
Referral Marketing Metadata API Types
Referral Mobile SDK
PDF

LoyaltyProgramProcess

Represents information about a process that processes transaction journals for a referral promotion’s advocates and their referred friends’ referral events. This object is available in API version 59.0 and later.

When a marketing manager activates a referral promotion, two processes are automatically created for the promotion. One process is used to process transaction journals of the subtype Referral Signup and the process rewards referrals when they sign up. The second process is used to process transaction journals of the subtype Advocate Reward and the process rewards advocates after their referrals complete their first purchase. Both processes aren’t for the marketing manager to view or edit.

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
The description or the business scenario of the process.
ExecutionType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
Required. Specifies the mode in which you want transaction journals to be processed by the process.
Possible values are:
  • Batch
  • BatchAndRealTime
  • RealTime
The default value is RealTime.
JournalSubTypeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
The ID of the journal subtype associated with the process. The process only processes transaction journals whose journal subtype is the same as the process.
This field is a relationship field.
Relationship Name
JournalSubType
Relationship Type
Lookup
Refers To
JournalSubType
JournalTypeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
The ID of the journal type associated with the process. The process only processes transaction journals whose journal type is the same as the process. For Referral Marketing, transaction journals are always associated with the Referral journal type.
This field is a relationship field.
Relationship Name
JournalType
Relationship Type
Lookup
Refers To
JournalType
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
Required. The ID of the referral program that the journal type belongs to.
This field is a relationship field.
Relationship Name
LoyaltyProgram
Relationship Type
Lookup
Refers To
LoyaltyProgram
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the journal type.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The owner of the record.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
ProcessType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
Required. The type of process. For Referral Marketing, the process type is always TransactionJournal.
Possible values are:
  • CancelVoucher—Reserved for internal use.
  • CreditPointsToMembers—Reserved for internal use.
  • DebitPointsFromMembers—Reserved for internal use.
  • EnrollInPromotion—Reserved for internal use.
  • GetMemberPromotions—Reserved for internal use.
  • IssueVoucher—Reserved for internal use.
  • OptOutPromotion—Reserved for internal use.
  • TierProcessing—Reserved for internal use.
  • TransactionJournal
  • UnenrollMember—Reserved for internal use.
  • UpdateMemberDetails—Reserved for internal use.
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Required. The status of the process.
Possible values are:
  • Active
  • Draft
  • Inactive
The default value is Draft.

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.

LoyaltyProgramProcessHistory
History is available for tracked fields of the object.
LoyaltyProgramProcessOwnerSharingRule
Sharing rules are available for the object.
LoyaltyProgramProcessShare
Sharing is available for the object.