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

PromotionTemplate

Represents the JSON configuration and details of a referral promotion template. This object is available in API version 61.0 and later.

You can create a promotion template and use the template to create promotions. After you create a promotion template, these PromotionStageTemplate records are automatically created and associated with the promotion template:

  • Promotion Launched
  • Advocate Joins Promotion
  • Advocate Refers Friend
  • Friend Signs Up
  • Friend Completes First Purchase

The Refer a Friend promotion template and its related PromotionStageTemplate records are provided by default.

Supported Calls

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

Fields

Field Details
Description
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
The description of the referral promotion template.
DeveloperName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. The developer name of the referral promotion template.
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, Nillable, Sort, Update
Description
The ID of the referral program that the referral promotion template is a part of.
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 referral promotion template.
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
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the status of the referral promotion template.
Possible values are:
  • Active
  • Draft
  • Inactive
The default value is Draft.
TemplateCategory
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the type of referral promotion template.
Possible values are:
  • Loyalty—Reserved for internal use.
  • Referral
The default value is Referral.
TemplateVersion
Type
int
Properties
Create, Filter, Group, Nillable, Sort
Description
The version number of the referral promotion template.

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.

PromotionTemplateShare
Sharing is available for the object.