Loyalty Management Developer Guide
jPromotion
Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields
BusinessUnitId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: ID of the internal organization unit that contains the details of the Marketing Cloud business unit associated with the promotion.
This field is a relationship field.
Relationship Name: BusinessUnit
Relationship Type: Lookup
Refers To: InternalOrganizationUnit
CampaignId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The campaign associated with the promotion.
This is a relationship field.
Relationship Name: Campaign
Relationship Type: Lookup
Refers To: Campaign
CumulativeUsageTarget
Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The number of times a member must participate or the amount of money spent to qualify for a reward.
CurrentLiabilityAmount
Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The liability amount incurred for the promotion until now. This field is available in API version 52.0 and later.
CurrentPointCount
Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The liability amount incurred for the promotion until now. This field is available in API version 52.0 and later.
DefaultVoucherDefinitionId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The voucher associated with the promotion.
This is a relationship field.
Relationship Name: DefaultVoucherDefinition
Relationship Type: Lookup
Refers To: VoucherDefinition
Description
Type: textarea
Properties: Create, Filter, Nillable, Sort, Update
Description: Description of the promotion.
DisplayName
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The display name of the promotion. This field is available in API version 60.0 and later where Global Promotions Management is enabled.
EndDate
Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: End date of the promotion.
EndDateTime
Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The end date and time of the promotion. This field is available in API version 60.0 and later where Unified Promotions is enabled.
EnrollmentEndDate
Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The last date to enroll in the promotion.
EnrollmentStartDate
Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The first date to enroll in the promotion.
FulfillmentAction
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Select how a loyalty member is rewarded for fulfilling promotion requirements.
Possible values are:
- CreditPoints—Credit Points
- IssueVoucher—Issue Voucher
GameDefinitionId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: ID of the game definition associated with the promotion.
This field is a relationship field.
Relationship Name: GameDefinition
Relationship Type: Lookup
Refers To: GameDefinition
ImageUrl
Type: url
Properties: Create, Filter, Nillable, Sort, Update
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.
The default value is false.
IssuedVoucherCount
Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The number of vouchers issued for the promotion until current date. This field is available in API version 52.0 and later.
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.
LoyaltyProgramCurrencyId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The loyalty program currency associated with the promotion.
This is a relationship field.
Relationship Name: LoyaltyProgramCurrency
Relationship Type: Lookup
Refers To: LoyaltyProgramCurrency
LoyaltyProgramId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The loyalty program associated with the promotion.
This 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: The type of promotion.
Possible values are:
- Cumulative
- Standard
- JointThis field is available in API version 55.0 and later.
MaximumLiabilityAmount
Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The maximum liability amount that can be incurred for the promotion.
MaximumRewardValue
Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The total value that can be accumulated for the promotion.
MaximumVoucherCount
Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The maximum number of vouchers that can be issued for the promotion. This field is available in API version 52.0 and later.
Name
Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: Unique identifier for the promotion.
Objective
Type: textarea
Properties: Create, Filter, Nillable, Sort, Update
Description: Business objective of the promotion. For example, launching a new product, keeping customers satisfied, or clearing stock.
OwnerId
Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The ID of the user who owns this record.
This 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: 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.
PriorityNumber
Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The priority number of the promotion. This field is available in API version 60.0 and later, where Global Promotions Management is enabled.
ProductCatalogId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
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.
This field is a relationship field.
Relationship Name: ProductCatalog
Relationship Type: Lookup
Refers To: ProductCatalog
PromotionCode
Type: string
Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
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.
RelatedPromotionId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: ID of the promotion that was cloned to create the promotion.
This field is a relationship field.
Relationship Name: RelatedPromotion
Relationship Type: Lookup
Refers To: Promotion
RuleLibraryId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: ID of the promotion that was cloned to create the promotion. This field is available in API version 62.0 and later.
This field is a relationship field.
Relationship Name: RelatedPromotion
Relationship Type: Lookup
Refers To: Promotion
StartDate
Type: date
Properties: Create, Filter, Group, Sort, Update
Description: Required. The start date of the promotion.
StartDateTime
Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
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.
Status
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The status of the promotion.
Possible values are:
- Cancelled
- Complete
- Draft
- InProgress
TotalRewardPoints
Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The points awarded on availing the promotion.
TransactionJournalType
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
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.
PromotionChangeEvent: Change events are available for the object.
PromotionFeed: Feed tracking is available for the object.
PromotionHistory: History is available for tracked fields of the object.
PromotionOwnerSharingRule: Sharing rules are available for the object.
PromotionShare: Sharing is available for the object.