Unified Promotions Input
Input representation of the promotion configuration to be created, or updated.
Before updating an existing promotion, get all the existing details of the promotion using the GET operation. To update an existing promotion using the PUT method, you must include all the existing field values of the promotion in the payload along with the new fields, or the fields to be updated.
unifiedPromotionsInputRepresentation
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
additionalFieldValues | Map<String, String> | Custom, and additional field values that provide more details about the promotion. | Optional | 60.0 |
businessUnit | Name And Id Input [] | ID or name of the Marketing Cloud business unit associated with the promotion. To specify a business unit, you must have the Marketing Cloud license. | Optional | 60.0 |
currencyIsoCode | String | ISO code of the active currency associated with the promotion. Before specifying the currency ISO code, make sure that your org supports multiple currencies. | Optional | 60.0 |
description | String | Description of the promotion. | Optional | 60.0 |
displayName | String | Display name of the promotion. | Optional | 60.0 |
endDateTime | String | Date and time until which the promotion can be applied for customers. | Optional | 60.0 |
isAutomatic | Boolean | Indicates whether the promotion is automatically applied for eligible carts (true) or not (false). | Optional | 63.0 |
isEmailActivated | Boolean | Indicates whether the promotion’s email is activated (true) or not (false). If set to true, an email template is created for the promotion’s email in the org. The default value is false. | Optional | Small, 60.0 |
loyaltyProgram | Name And Id Input [] | ID or name of the active loyalty program the promotion applies to. You can’t change the loyalty program of an existing promotion. | Optional | 60.0 |
name | String | Unique name of the promotion. | Required | 60.0 |
objective | String | Objective of the promotion. | Optional | 60.0 |
priorityNumber | Integer | Number that determines the priority of the promotion in a list of eligible promotions. Priority number must be greater than zero. | Optional | 60.0 |
promotionCode | String | Unique code of the promotion. | Optional | 60.0 |
promotionEligibility | Promotion Eligibility Input | Eligibility criteria of the promotion. | Optional | 60.0 |
promotionLimits | Promotion Limit Input | Limits of the promotion, including the number of times the promotion can be applied for customers. A promotion limit must be greater than zero. | Optional | 60.0 |
ruleLibrary | String | Rule library associated with the promotion. | Optional | 62.0 |
startDateTime | String | Date and time from which the promotion can be applied for customers. | Required | 60.0 |
termsAndConditions | String | Terms and conditions which are applied to the promotion. | Optional | 63.0 |