Create a Decision Item
Each code-based Experience Decision begins with Decisions Items. These are the individual offers that a person might qualify for. The Decision Item includes a time window for which the individual offer is valid, criteria that dictates who the offer is valid for, and the contents of the offer (eg, text, urls, structured data). Let's begin by creating a Decision Item.
Request
Request Type: POST
Endpoint: https://platform.adobe.io/data/core/dps/offer-items/
Headers
Key | Value |
|---|---|
Authorization | Bearer <VARIES> |
x-api-key | <VARIES> (e.g. 1234b8e8cd0a48918412d22dd9b01234) |
x-gw-ims-org-id | 59C7440F5DE147EA0A495EB3@AdobeOrg |
accept | application/json |
Content-Type | application/json |
x-sandbox-name | <VARIES> (e.g. lab612-01) |
x-schema-id | <VARIES> (e.g. https://ns.adobe.com/adobedemoamericas275/schemas/dc5b593541543883856ef0f29f35923ad24a963d5ff35646) |
Request Parameters
Parameter | Example | Type | Description | Required |
|---|---|---|---|---|
decisioning | | object | contains decision metadata such as active time constraints, audience constraints, description, name, priority, etc. | YES |
decisionItem | | object | contains decision metadata such as active time constraints | YES |
itemCalendarConstraints | | object | contains active time constraints | YES |
itemCatalogId | dps:decision-catalog:1a386cd47beb42b4 | string | the ID of the item catalog specific to the AEP sandbox | YES |
profileConstraintType | allSegments | string | defines the audience constraint type | YES |
segmentIdentities | | object | contains an array of audience segments by which to constrain the decision item | YES |
namespace.code | ups | string | location from which to retrieve profile identities | VARIES, dependent on profileConstraintType |
segmentIdentities._id | 863aaf04-9c28-44f2-9053-573e469a8be2 | string | ID of the audience segment | VARIES, dependent on profileConstraintType |
itemDescription | a credit card off for a consumer audience | string | Human readable description of the decision item | NO |
itemName | Credit Card Offer | string | Human readable name of the decision item | YES |
itemPriority | 100 | integer | baseline priority for the decision item that is used to compare against other decision items in the event a profile qualifies for competing offers | YES |
_adobedemoamericas275 | see description | object | the IMSorg tenant name that varies with each instance of AEP | YES |
offerMetadata | | object | an object that contains user configurable metadata objects and attributes | YES |
offerImageUrl | https://adbecdn.blob.core.windows.net/hol/image.png | string | user configurable attribute that contains the offer image | VARIES, user configurable |
offerImageDesc | consumer card offer | string | user configurable attribute that contains the offer image description | VARIES, user configurable |
offerText | Earn unlimited 5% Cash Back rewards on every purchase made | string | user configurable attribute that contains the offer text | VARIES, user configurable |
offerTitle | SecurFinancial Platinum Card | string | user configurable attribute that contains the offer title | VARIES, user configurable |
offerCollectionTag | platinumMikeSimpson | string | user configurable attribute that contains a tag used for organizing offers into a collection | VARIES, user configurable |
Request Body
{
"_experience": {
"decisioning": {
"offeritem": {
"lifecycleStatus": "approved"
},
"decisionitem": {
"itemCalendarConstraints": {
"endDate": "2030-12-31T08:00:00.000Z",
"startDate": "2024-06-10T04:00:00.000Z"
},
"itemCatalogID": "dps:decision-catalog:1a386cd47beb42b4",
"itemConstraints": {
"profileConstraintType": "allSegments",
"segmentIdentities": [
{
"namespace": {
"code": "ups"
},
"_id": "574f9eae-8edf-49d9-af43-5ac6845dd0e1"
},
{
"namespace": {
"code": "ups"
},
"_id": "863aaf04-9c28-44f2-9053-573e469a8be2"
}
]
},
"itemDescription": "Offer item description",
"itemName": "Decision Item Create Test",
"itemPriority": 100
}
}
},
"_adobedemoamericas275": {
"offerMetadata": {
"offerImageUrl": "https://adbecdn.blob.core.windows.net/summithol25/credit-cards/card-premium-500.png",
"offerImageDesc": "platinum consumer card offer",
"offerText": "Earn unlimited 5% Cash Back rewards on every purchase made",
"offerTitle": "SecurFinancial Platinum Card",
"offerCollectionTag": "platinumTest"
}
}
}Relevant Response Parameters
Attribute | Example | Description |
|---|---|---|
id | dps:dc5b593541543883856ef0f29f35923ad24a963d5ff35646:1a4e5761088ba551 | the ID of the decision item |
sandboxId | 71795633-d212-4495-b956-33d212849517 | the ID of the sandbox in which the decision item was created |
Response Body
{
"id": "dps:dc5b593541543883856ef0f29f35923ad24a963d5ff35646:1a4e5761088ba551",
"sandboxId": "71795633-d212-4495-b956-33d212849517",
"etag": 1,
"createdDate": "2025-02-28T18:56:10.723Z",
"lastModifiedDate": "2025-02-28T18:56:10.723Z",
"createdBy": "[email protected]",
"lastModifiedBy": "[email protected]",
"createdByClientId": "c4a0b8e8cd0a48918412d22dd9b0c7f5",
"lastModifiedByClientId": "c4a0b8e8cd0a48918412d22dd9b0c7f5"
}