PromotionStageTemplate

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

A promotion template includes templates for each promotion stage. Each promotion stage template contains the details of each promotion stage.

These templates are automatically created when you create a promotion template for a B2C referral program:

Promotion Launched—You can’t change the stage name and you can’t reward advocates or their referred friends.
Advocate Joins Promotion—You can’t change the stage name and you can’t reward advocates or their referred friends.
Advocate Refers Friend—You change the stage name and reward advocates or their referred friends.
Friend Signs Up—You change the stage name and reward advocates or their referred friends.
Friend Completes First Purchase—You change the stage name and reward advocates or their referred friends.

These templates are automatically created when you create a promotion template for a B2B referral program:

Promotion Launched—You can’t change the stage name and you can’t reward advocates or their referred friends.
Advocate Joins Promotion—You can’t change the stage name and you can’t reward advocates or their referred friends.
Advocate Submits Referral—You change the stage name and reward advocates.
Referral Qualifies—You change the stage name and reward advocates or their referred parties.
Referral Closure/Converts—You change the stage name and reward advocates or their referred parties.

When you use a promotion template to create a promotion, the promotion stage templates related to the promotion template are automatically used to create the stages of the promotion.

Supported Calls

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

Fields

Description

Type: textarea

Properties: Create, Filter, Nillable, Sort, Update

Description: The description of the referral promotion stage template.

DeveloperName

Type: string

Properties: Create, Filter, Group, Sort, Update

Description: Required. The developer name of the referral promotion stage 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.

Name

Type: string

Properties: Create, Filter, Group, idLookup, Sort, Update

Description: The name of the referral promotion stage template.

PromotionTemplateId

Type: reference

Properties: Create, Filter, Group, Sort

Description: The ID of the referral promotion template that the referral promotion stage template is a part of.

This field is a relationship field.

Relationship Name: PromotionTemplate

Relationship Type: Master-detail

Refers To: PromotionTemplate (the master object)

ReferredPartyJournalSubTypeId

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The ID of the journal subtype that represents the activity for which referred parties are rewarded.

This field is a relationship field.

Relationship Name: ReferredPartyJournalSubType

Relationship Type: Lookup

Refers To: JournalSubType

ReferrerJournalSubTypeId

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The ID of the journal subtype that represents the activity for which advocates are rewarded.

This field is a relationship field.

Relationship Name: ReferrerJournalSubType

Relationship Type: Lookup

Refers To: JournalSubType

RewardRecipient

Type: multipicklist

Properties: Create, Filter, Nillable, Update

Description: Specifies the audience of the promotion stage template’s reward. Specify a value only when the promotion stage template represents a promotion stage that rewards advocates, their referred friends, or both.

Possible values are:

Advocate
Friend—For B2B referral programs friend represents referred party

SequenceNumber

Type: int

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The sequence number of the referral promotion stage template in the associated referral promotion template.

Type

Type: picklist

Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description: Specifies the type of referral promotion stage that the referral promotion stage template belongs to.

Possible values are:

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