Represents a promotion associated with the loyalty program. It captures the information such as type of the promotion, issue of a voucher or credit points, promotion enrollment, and status of the promotion. This object is available in API version 51.0 and later.
Description: The URL for the promotion image. This field is available in API version 57.0 and later.
IsActive
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the promotion is active. This field is available in API version 52.0 and later.
IsCloned
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the promotion has been created by cloning an existing promotion. This field is available in API version 61.0 and later.
The default value is false.
IsEnrollmentRequired
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether enrollment is required to participate in the promotion.
IsPointsWithFactor
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the promotion is applied by multiplying points with a factor or by using the fixed value in the TotalRewardPoints field. This field is available in API version 52.0 and later.
The default value is False.
IsQuickPromotion
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the records represent a quick promotion (true) or not (false). This field is available in API version 57.0 and later.
Description: The factor with which points are multiplied or divided when IsPointsWithFactor is set to true. This field is available in API version 52.0 and later.
Description: The priority number of the promotion. This field is available in API version 60.0 and later, where Global Promotions Management is enabled.
Description: ID of the product catalog associated with the promotion. This field is available in API version 60.0 and later, where Global Promotions Management is enabled.
Description: The unique code of the promotion. This field is available in API version 60.0 and later, where Global Promotions Management is enabled.
PromotionConfiguration
Type: textarea
Properties: Create, Nillable, Update
Description: A JSON representation of a promotion’s configuration, including eligibility rules and reward details. Depending on the selected template and eligibility criteria, it contains information, such as product IDs, that changes across orgs. When migrating promotions across orgs, the IDs in this JSON must match the data in the target org. Salesforce recommends using the Promotion APIs for an efficient migration instead of updating the field manually. This field is used only when IsQuickPromotion is set to true. This field is available in API version 57.0 and later.
Description: The start date and time of the promotion. This field is available in API version 60.0 and later where Global Promotions Management is enabled.
Description: The journal type that has been applied for the promotion. This field is available in API version 52.0 and later.
Possible values are:
Accrual
Redemption
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.