PromotionStage

Represents a stage in a referral promotion. This object is available in API version 59.0 and later.

When you create a referral promotion, five stages are created to the promotion by default:

  • Promotion Launched—During this stage, an email is sent to the referral promotion’s target audience.
  • Advocate Joins Promotion—During this stage, existing customers join the referral promotion as advocates.
  • Advocate Refers Friend—During this stage, advocates refer their friends.
  • Friend Signs Up—During this stage, referred friends sign up as new customers.
  • Friend Completes First Purchase—During this stage, a referred friend completes their first purchase.

Supported Calls

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

Fields

Field Details
ApiName
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Required. The unique name of the promotion stage.
Configuration
Type
textarea
Properties
Create, Nillable, Update
Description
The configuration of the promotion stage.
Description
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
The description of the promotion stage.
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 promotion stage.
PromotionId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the referral promotion that the stage belongs to.
This field is a relationship field.
Relationship Name
Promotion
Relationship Type
Lookup
Refers To
Promotion
ReferredPartyJournalSubTypeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the journal subtype that represents the activity for which the referred friend is rewarded during the referral promotion stage.
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 the advocate is rewarded during the referral promotion stage.
This field is a relationship field.
Relationship Name
ReferrerJournalSubType
Relationship Type
Lookup
Refers To
JournalSubType
SequenceNumber
Type
int
Properties
Create, Filter, Group, Sort, Update
Description
Required. The sequence number of the stage in a referral promotion. For example, the sequence number of the Promotion Launched stage is 1.
Type
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Required. The type of promotion stage. Each of the default Promotion Stage records are assigned its own promotion stage type. For example, Promotion Launch is the type for the Promotion Launched stage.
Possible values are:
  • Customer Joins Promotion
  • Customer Refers Friend
  • Promotion Launch
  • Referral Completes First Purchase
  • Referral Signs Up