Salesforce · Schema
PromotionsCreationRequest
Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales
Properties
| Name | Type | Description |
|---|---|---|
| name | string | |
| startDateTime | string | |
| displayName | string | |
| priorityNumber | integer | |
| description | string | |
| endDateTime | string | |
| objective | string | |
| loyaltyProgram | object | |
| additionalFieldValues | object | |
| promotionLimits | object | |
| promotionEligibility | object |
JSON Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Example Title"
},
"startDateTime": {
"type": "string",
"example": "2026-01-15T10:30:00Z"
},
"displayName": {
"type": "string",
"example": "example_value"
},
"priorityNumber": {
"type": "integer",
"example": 10
},
"description": {
"type": "string",
"example": "A sample description."
},
"endDateTime": {
"type": "string",
"example": "2026-01-15T10:30:00Z"
},
"objective": {
"type": "string",
"example": "example_value"
},
"loyaltyProgram": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Example Title"
}
},
"required": [
"name"
]
},
"additionalFieldValues": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"properties": {
"promotionLocation__c": {
"type": "string",
"example": "example_value"
}
},
"required": [
"promotionLocation__c"
]
}
},
"required": [
"attributes"
]
},
"promotionLimits": {
"type": "object",
"properties": {
"perLineItemLimit": {
"type": "integer",
"example": 10
},
"vouchersLimit": {
"type": "integer",
"example": 10
},
"vouchersPerCustomerLimit": {
"type": "integer",
"example": 10
},
"perCartLimit": {
"type": "integer",
"example": 10
},
"usePerCustomerLimit": {
"type": "integer",
"example": 10
},
"liabilityLimit": {
"type": "integer",
"example": 10
},
"loyaltyProgramCurrency": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "abc123"
}
},
"required": [
"id"
]
},
"pointsPerCustomerLimit": {
"type": "integer",
"example": 10
}
},
"required": [
"perLineItemLimit",
"vouchersLimit",
"vouchersPerCustomerLimit",
"perCartLimit",
"usePerCustomerLimit",
"liabilityLimit",
"loyaltyProgramCurrency",
"pointsPerCustomerLimit"
]
},
"promotionEligibility": {
"type": "object",
"properties": {
"eligibleProductCategories": {
"type": "array",
"description": "",
"example": [],
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "abc123"
}
},
"required": [
"id"
]
}
},
"eligibleProducts": {
"type": "array",
"description": "",
"example": [],
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Example Title"
}
},
"required": [
"name"
]
}
},
"eligibleChannels": {
"type": "array",
"description": "",
"example": [],
"items": {
"type": "object",
"properties": {
"channelType": {
"type": "string",
"example": "example_value"
},
"store": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Example Title"
}
},
"required": [
"name"
]
},
"retailLocationGroup": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Example Title"
}
},
"required": [
"name"
]
}
},
"required": [
"channelType",
"store",
"retailLocationGroup"
]
}
},
"eligibleCustomerEvents": {
"type": "object",
"properties": {
"event": {
"type": "string",
"example": "example_value"
},
"eventPeriodUnit": {
"type": "string",
"example": "example_value"
}
},
"required": [
"event",
"eventPeriodUnit"
]
},
"eligibleEnrollmentPeriod": {
"type": "object",
"properties": {
"isEnrollmentRequired": {
"type": "boolean",
"example": true
},
"enrollmentStartDate": {
"type": "string",
"example": "example_value"
},
"enrollmentEndDate": {
"type": "string",
"example": "example_value"
}
},
"required": [
"isEnrollmentRequired",
"enrollmentStartDate",
"enrollmentEndDate"
]
},
"eligibleLoyaltyTiers": {
"type": "array",
"description": "",
"example": [],
"items": {
"type": "object",
"properties": {
"tierGroup": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Example Title"
},
"id": {
"type": "string",
"example": "abc123"
}
},
"required": [
"name",
"id"
]
},
"tier": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Example Title"
},
"id": {
"type": "string",
"example": "abc123"
}
},
"required": [
"name",
"id"
]
}
},
"required": [
"tierGroup",
"tier"
]
}
}
},
"required": [
"eligibleProductCategories",
"eligibleProducts",
"eligibleChannels",
"eligibleCustomerEvents",
"eligibleEnrollmentPeriod",
"eligibleLoyaltyTiers"
]
}
},
"required": [
"name",
"startDateTime",
"displayName",
"priorityNumber",
"description",
"endDateTime",
"objective",
"loyaltyProgram",
"additionalFieldValues",
"promotionLimits",
"promotionEligibility"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "PromotionsCreationRequest"
}