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
InternalOrgUnitCommChannel
JournalSubType
JournalType
LoyaltyPgmEngmtAttribute
LoyaltyPgmMbrAttributeVal
LoyaltyProgram
LoyaltyProgramMbrPromotion
LoyaltyProgramMember
LoyaltyProgramProcess
LoyaltyProgramProcessRule
LoyaltyProgramWidget
Promotion
PromotionMarketSegment
PromotionStage
PromStageCommChannelTmpl
PromotionStageEmailTemplate
PromotionStageTemplate
PromotionTemplate
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

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.

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
The description or the business value of the referral program.
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
The name of the referral program.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The owner of the referral program.
This field 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. Specifies the status of the referral program.
Possible values are:
  • Active
  • Inactive
The default value is Active.
Type
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Required. Specifies the type of program.
Possible value is:
  • REFERRAL_PROGRAM

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.

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.