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

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.

Supported Calls

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

Fields

Field Details
CustomizedContent
Type
textarea
Properties
Create, Nillable, Update
Description
The details of a widget’s customizations.
Description
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The description or the business use case of the widget.
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 widget.
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
ProgramId
Type
reference
Properties
Create, Filter, Group, Sort
Description
Required. The ID of the referral program that the widget belongs to.
This field is a relationship field.
Relationship Name
Program
Relationship Type
Lookup
Refers To
LoyaltyProgram
PromotionId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the promotion that the widget belongs to.
This field is a relationship field.
Relationship Name
Promotion
Relationship Type
Lookup
Refers To
Promotion
PromotionStageId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the promotion stage that the widget represents. The widget that marketing managers design when creating a referral promotion is associated with the Promotion Launched stage.
This field is a relationship field.
Relationship Name
PromotionStage
Relationship Type
Lookup
Refers To
PromotionStage
TemplateName
Type
string
Properties
Create, Filter, Group, Sort
Description
Required. The name of the widget template used to create the widget.
TemplateVersion
Type
int
Properties
Create, Filter, Group, Sort
Description
Required. The version of the widget template used to create the widget.

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.

LoyaltyProgramWidgetShare
Sharing is available for the object.