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.
For B2C referral programs:
- 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 for B2C referral programs.
For B2B referral programs:
- Promotion Launched
- Advocate Joins Promotion
- Advocate Submits Referral
- Referral Qualifies
- Referral Closure/Converts
The Refer a Lead promotion template and its related PromotionStageTemplate records are provided by default for B2B referral programs.
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()
Type: textarea
Properties: Create, Filter, Nillable, Sort, Update
Description: The description of the referral promotion template.
Type: string
Properties: Create, Filter, Group, Sort, Update
Description: Required. The developer name of the referral promotion template.
Type: dateTime
Properties: Filter, Nillable, Sort
Description: The most recent date on which a user referenced this record.
Type: dateTime
Properties: Filter, Nillable, Sort
Description: The most recent date on which a user viewed this record.
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
Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: The name of the referral promotion template.
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
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:
ActiveDraftInactive
The default value is Draft.
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 and isn’t required for B2C or B2B referral programs. Don’t use this value to customize or extend your implementation.Referral
The default value is Referral.
Type: int
Properties: Create, Filter, Group, Nillable, Sort
Description: The version number of the referral promotion template.
Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the type of promotion template based on target markets.
Possible values are:
B2B - Business to BusinessB2C - Business to Customer
The default value is B2C - Business to Customer.
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.