Promotion

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

Supported Calls

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

Fields

Field	Details
CampaignId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the campaign whose members are the promotion’s target audience. This field is a relationship field. Relationship Name Campaign Relationship Type Lookup Refers To Campaign
CumulativeUsageTarget	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use.
CurrentLiabilityAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The liability that’s incurred by the company for the promotion till date.
CurrentPointCount	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use.
DefaultVoucherDefinitionId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use. This field is a relationship field. Relationship Name DefaultVoucherDefinition Relationship Type Lookup Refers To VoucherDefinition
Description	Type textarea Properties Create, Filter, Nillable, Sort, Update Description The description of the promotion.
EndDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date until which the referral promotion is run by the company.
EnrollmentEndDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date until which advocates can join the referral promotion.
EnrollmentStartDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date from which advocates can join the referral promotion.
FulfillmentAction	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Reserved for internal use. Possible values are: `CreditPoints` `IssueVoucher`
ImageUrl	Type url Properties Create, Filter, Nillable, Sort, Update Description The URL of the file that contains the marketing image of the promotion.
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a promotion is active (`true`) or not (`false`). The default value is `false`.
IsEnrollmentRequired	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether advocates need to join the promotion before they can refer their friends (`true`) or not (`false`). The default value is `false`.
IsPointsWithFactor	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Reserved for internal use. The default value is `false`.
IsQuickPromotion	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Reserved for internal use. The default value is `false`.
IsReferralPromotion	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the promotion is for a referral program (`true`) or not (`false`). Specify `true` for all the promotions that you create for your referral program. The default value is `false`.
IssuedVoucherCount	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The count of vouchers that have been issued to advocates and their referred friends as promotion reward.
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 promotion is a part of. This field is a relationship field. Relationship Name LoyaltyProgram Relationship Type Lookup Refers To LoyaltyProgram
LoyaltyPromotionType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the referral promotion type. For referral promotions, specify the type as Standard. Possible values are: `Cumulative` `Joint` `Standard`
MaximumLiabilityAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The maximum liability that the company can incur for the promotion.
MaximumRewardValue	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use.
MaximumVoucherCount	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum number of vouchers that issued to advocates and their referred friends as promotion rewards.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the promotion.
Objective	Type textarea Properties Create, Filter, Nillable, Sort, Update Description The business objective of the promotion.
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
PointFactor	Type double Properties Create, Filter, Nillable, Sort, Update Description Reserved for internal use.
PromotionCode	Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The unique code of the promotion.
PromotionConfiguration	Type textarea Properties Create, Nillable, Update Description The configuration of the promotion. The configuration stores details like the email templates of each promotion stage, the promotion audience, referral rewards, and the reward limits.
PromotionPageUrl	Type url Properties Create, Filter, Nillable, Sort, Update Description The URL of the Experience Cloud or external page where advocates can sign up for the referral promotion or learn about it.
ReferralType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the type of referral promotion. Possible values are: `Refer Friends`
RelatedReferralProgramId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The referral program that accounts for the budget of the referral promotion. This field is a relationship field. Relationship Name RelatedReferralProgram Relationship Type Lookup Refers To LoyaltyProgram
StartDate	Type date Properties Create, Filter, Group, Sort, Update Description Required. The start date of the referral promotion.
Status	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Reserved for internal use. Possible values are: `Cancelled` `Complete` `Draft` `InProgress`
TotalRewardPoints	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use.
TransactionJournalType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Reserved for internal use. Possible values are: `Accrual` `Redemption`
UsageType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Reserved for internal use. Possible values are: `LOYALTY`—Loyalty `MANUFACTURING`—Manufacturing

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.

PromotionFeed: Feed tracking is available for the object.
PromotionHistory: History is available for tracked fields of the object.
PromotionShare: Sharing is available for the object.

Referral Marketing Developer Guide

Promotion

Supported Calls

Fields

Associated Objects