Recommendations API

Download OpenAPI specification:Download

API Reference

Recommendations API are based on REST. This describes the resources that make up the official Adobe Target Recommendations API. The resources are designated by nouns or objects in the world of Recommendations like a feed or a design. The functionalities or operations on resources are designated by HTTP methods in each resource request.

Getting Started

A Recommendations API call looks like this:

curl -X POST \
https://mc.adobe.io/{{tenantId}}/target/recs/collections \
-H 'Accept: application/vnd.adobe.target.v1+json' \
-H 'Authorization: Bearer {{bearerToken}}' \
-H 'Content-Type: application/vnd.adobe.target.v1+json' \
-H 'X-Api-Key: {{xApiKey}}' \
-d '{
  "name": "Backpacking Tents",
  "rules": [
    {
      "id": {
        "contains": [
          "backpacking"
        ]
      }
    }
  ]
}'

The tenantId is your Adobe Experience Cloud tenant ID. It is present as a subdomain of your Experience Cloud URL. For example, if your Experience Cloud URL is piedpiper.experiencecloud.adobe.com or piedpiper.marketing.adobe.com, the tenant ID is piedpiper.

bearerToken and xApiKey are security token variables explained below in Authentication.

Limitations

  • These APIs do not allow you to interact with resources created in the Recommendations Classic.
  • Resources can not be deleted until they are no longer referenced by any other resources. For example, a criteria cannot be deleted if its being used in a recommendation activity. It can only be deleted if its removed from from wherever it is used.
  • This documentation does not include following APIs:
    • Entity Recommendation Download (legacy): To download CSV containing entity recommendations.
    • Custom Algorithm Upload (legacy): To upload custom algorithm feed through POST request.
    • Exclusions
    • Feeds

Postman

All Recommendations API requests are available in a Postman collection. Click the "Run in Postman" button to download the collection as a JSON file, then import it in Postman. Note this collection references a Postman environment, which is available from the Adobe I/O console integration page for your specific integration.

Run in Postman

Authentication

Bearer Token

This API requires a bearer token for authentication and an API Key for authorization. To obtain them, you must create an integration in the Adobe I/O Console. Refer *How to set up Adobe IO Authentication - Step by Step* for information on creating the integration and obtaining a bearer token.

Security scheme type: HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

API Key

This API requires an API key for authorization and bearer token for authentication. The API Key is obtained when creating an integration in the Adobe I/O Console. Refer *How to set up Adobe IO Authentication - Step by Step* for information on creating the integration.

Security scheme type: API Key
header parameter name: X-Api-Key

Collections

A collection is a set of items that are eligible for a recommendation. It is defined by a set of membership rules. If an item satisfies these rules, it is a member of the collection.

List collections

get /collections

Adobe I/O gateway

https://mc.adobe.io/{tenantId}/target/recs/collections

Gets all available collections.

Authorizations:
query Parameters
offset
integer <int32> (offset)

Number of resources to skip from start in the server list. If not specified, the response list will start from first available resource.

limit
integer <int32> (limit)

Number of resources to request. If not specified, the response will include all available resources.

Responses

200

Successful request with list of collection resources in response

Response samples

application/vnd.adobe.target.v1+json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "offset": 0,
  • "limit": 2147483647,
  • "total": 2,
  • "list":
    [
    ]
}

Create collection

post /collections

Adobe I/O gateway

https://mc.adobe.io/{tenantId}/target/recs/collections

Creates a new collection as specified by the rules provided and returns the newly created collection definition.

Authorizations:
Request Body schema: application/vnd.adobe.target.v1+json
name
required
string <= 250 characters

Unique name of the collection.

rules
required
Array of object (RestBasicMatcher) [ 1 .. 1000 ] items

Array of rules containing attribute : operation pairs.

The attribute is any valid entity attribute. It is a required field and it should not be more than 100 characters.

The operation is a pair of operator and operand values. The operator can be one of:

  • Numeric operators: greaterOrEquals, lesserOrEquals
  • String operators: startsWith, endsWith, contains, doesNotContain
  • Alphanumeric operators: equals, notEquals, valueIsPresent, valueIsNotPresent

The other part of operation, operand values, is an array of values. Each value cannot be more than 250 characters. There must be atleast 1 value and no more than 1000 values. Operand values are not required when operator is either valueIsPresent or valueIsNotPresent. Numeric operators accept integer or floating point operand values.

Responses

201

Collection resource created with resource definition in response

Request samples

application/vnd.adobe.target.v1+json
Copy
Expand all Collapse all
{
  • "name": "Backpacking Tents",
  • "rules":
    [
    ]
}

Response samples

application/vnd.adobe.target.v1+json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "id": 1,
  • "name": "Backpacking Tents",
  • "rules":
    [
    ]
}

Get collection

get /collections/{id}

Adobe I/O gateway

https://mc.adobe.io/{tenantId}/target/recs/collections/{id}

Gets the collection with the given ID.

Authorizations:
query Parameters
limit
integer <int32> (limit)

Number of resources to request. If not specified, the response will include all available resources.

Responses

200

Successful request with collection resource in response

Response samples

application/vnd.adobe.target.v1+json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "id": 1,
  • "name": "Backpacking Tents",
  • "rules":
    [
    ]
}

Edit collection

put /collections/{id}

Adobe I/O gateway

https://mc.adobe.io/{tenantId}/target/recs/collections/{id}

Updates the collection with new name and/or new rules as specified and returns the updated collection definition.

Authorizations:
query Parameters
limit
integer <int32> (limit)

Number of resources to request. If not specified, the response will include all available resources.

Request Body schema: application/vnd.adobe.target.v1+json
name
required
string <= 250 characters

Unique name of the collection.

rules
required
Array of object (RestBasicMatcher) [ 1 .. 1000 ] items

Array of rules containing attribute : operation pairs.

The attribute is any valid entity attribute. It is a required field and it should not be more than 100 characters.

The operation is a pair of operator and operand values. The operator can be one of:

  • Numeric operators: greaterOrEquals, lesserOrEquals
  • String operators: startsWith, endsWith, contains, doesNotContain
  • Alphanumeric operators: equals, notEquals, valueIsPresent, valueIsNotPresent

The other part of operation, operand values, is an array of values. Each value cannot be more than 250 characters. There must be atleast 1 value and no more than 1000 values. Operand values are not required when operator is either valueIsPresent or valueIsNotPresent. Numeric operators accept integer or floating point operand values.

Responses

200

Successful request with updated collection resource in response

Request samples

application/vnd.adobe.target.v1+json
Copy
Expand all Collapse all
{
  • "name": "Backpacking Tents",
  • "rules":
    [
    ]
}

Response samples

application/vnd.adobe.target.v1+json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "id": 1,
  • "name": "Backpacking Tents",
  • "rules":
    [
    ]
}

Delete collection

delete /collections/{id}

Adobe I/O gateway

https://mc.adobe.io/{tenantId}/target/recs/collections/{id}

Deletes the collection referenced by the given ID.

Authorizations:
query Parameters
limit
integer <int32> (limit)

Number of resources to request. If not specified, the response will include all available resources.

Responses

200

Successful request with deleted collection resource in response

Response samples

application/vnd.adobe.target.v1+json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "id": 1,
  • "name": "Backpacking Tents",
  • "rules":
    [
    ]
}

Criteria

Criteria are rules that determine which items to recommend based on a predetermined set of visitor behaviors. Criteria are categorized into different groups depending on the recommendation key and recommendation logic. These groups are: category, item, recent, popularity, profile attribute, custom.

List criteria

get /criteria

Adobe I/O gateway

https://mc.adobe.io/{tenantId}/target/recs/criteria

Gets all available criteria.

Authorizations:
query Parameters
offset
integer <int32> (offset)

Number of resources to skip from start in the server list. If not specified, the response list will start from first available resource.

limit
integer <int32> (limit)

Number of resources to request. If not specified, the response will include all available resources.

Responses

200

Successful request with list of criteria resources in response

Response samples

application/vnd.adobe.target.v1+json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "offset": "2,",
  • "limit": "2147483647,",
  • "total": 3,
  • "list":
    [
    ]
}

Get criteria

get /criteria/{id}

Adobe I/O gateway

https://mc.adobe.io/{tenantId}/target/recs/criteria/{id}

Gets minimal criteria information with the given ID. For detailed information, make API call to criteria group path, for example, /criteria/item/{id}.

Authorizations:
path Parameters
id
required
integer <int32>

Responses

200

Successful request with criteria resource in response

Response samples

application/vnd.adobe.target.v1+json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "id": 34,
  • "name": "Recently Viewed Biking Accessories",
  • "criteriaTitle": "Recently Viewed Biking Accessories",
  • "criteriaGroup": "RECENT"
}

Designs

A design is a script that is used to determine how your recommendations look. You can create customized designs to provide the appearance you desire. The script can be HTML or non-HTML; non-HTML for non-web environments where click-tracking is not possible. Recommendation designs use Apache Velocity, so the script should make use of Velocity Template Language.

List designs

get /designs

Adobe I/O gateway

https://mc.adobe.io/{tenantId}/target/recs/designs

Gets all available designs.

Authorizations:
query Parameters
offset
integer <int32> (offset)

Number of resources to skip from start in the server list. If not specified, the response list will start from first available resource.

limit
integer <int32> (limit)

Number of resources to request. If not specified, the response will include all available resources.

includeScript
boolean

Whether to include the design content.

Responses

200

Successful request with list of design resources in response

Response samples

application/vnd.adobe.target.v1+json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "offset": 0,
  • "limit": 2147483647,
  • "total": 1,
  • "list":
    [
    ]
}

Create a design

post /designs

Adobe I/O gateway

https://mc.adobe.io/{tenantId}/target/recs/designs

Creates a new design as specified by the script provided and returns the newly created design definition.

Authorizations:
Request Body schema: application/vnd.adobe.target.v1+json
name
required
string <= 250 characters

Unique name of the design.

script
required
string <= 65000 characters

Velocity template containing at least one entity object. Velocity Engine 1.7 is supported.

Responses

201

Design resource created with resource definition in response

Request samples

application/vnd.adobe.target.v1+json
Copy
Expand all Collapse all
{
  • "name": "Landing Page",
  • "script": "name = $entity1.name<br/> details= $entity1.details <table>\n <tr>\n <td>\n <a href=\"$entity1.pageUrl\">\n <img src=\"$entity1.thumbnailUrl\"/>\n <br/>$profile\n <br/> $token\n <br/>$url\n </a>\n </td>\n <td>\n <a href=\"$entity2.pageUrl\">\n <img src=\"$entity2.thumbnailUrl\"/> \n <br/>$entity2.name\n <br/>$entity2.message\n <br/> $entity2.value\n </a>\n </td>\n <td>\n <a href=\"$entity3.pageUrl\">\n <img src=\"$entity3.thumbnailUrl\"/> \n <br/>$entity3.name\n <br/>$entity3.message\n <br/> $entity3.value\n </a>\n </td>\n </tr>\n</table>"
}

Response samples

application/vnd.adobe.target.v1+json
Copy
Expand all Collapse all
{
  • "id": 1,
  • "name": "Landing Page",
  • "script": "<table>\n <tr>\n <td>\n <a href=\"$entity1.pageUrl\">\n <img src=\"$entity1.thumbnailUrl\"/>\n <br/>$profile\n <br/> $token\n <br/>$url\n </a>\n </td>\n <td>\n <a href=\"$entity2.pageUrl\">\n <img src=\"$entity2.thumbnailUrl\"/> \n <br/>$entity2.name\n <br/>$entity2.message\n <br/> $entity2.value\n </a>\n </td>\n <td>\n <a href=\"$entity3.pageUrl\">\n <img src=\"$entity3.thumbnailUrl\"/> \n <br/>$entity3.name\n <br/>$entity3.message\n <br/> $entity3.value\n </a>\n </td>\n </tr>\n</table>"
}

Get design

get /designs/{id}

Adobe I/O gateway

https://mc.adobe.io/{tenantId}/target/recs/designs/{id}

Gets the design with the given ID.

Authorizations:
path Parameters
id
required
integer <int32>
query Parameters
includeScript
boolean

Whether to include the design content.

Responses

200

Successful request with design resource in response

Response samples

application/vnd.adobe.target.v1+json
Copy
Expand all Collapse all
{
  • "id": 1,
  • "name": "Landing Page",
  • "script": "<table>\n <tr>\n <td>\n <a href=\"$entity1.pageUrl\">\n <img src=\"$entity1.thumbnailUrl\"/>\n <br/>$profile\n <br/> $token\n <br/>$url\n </a>\n </td>\n <td>\n <a href=\"$entity2.pageUrl\">\n <img src=\"$entity2.thumbnailUrl\"/> \n <br/>$entity2.name\n <br/>$entity2.message\n <br/> $entity2.value\n </a>\n </td>\n <td>\n <a href=\"$entity3.pageUrl\">\n <img src=\"$entity3.thumbnailUrl\"/> \n <br/>$entity3.name\n <br/>$entity3.message\n <br/> $entity3.value\n </a>\n </td>\n </tr>\n</table>"
}

Edit design

put /designs/{id}

Adobe I/O gateway

https://mc.adobe.io/{tenantId}/target/recs/designs/{id}

Updates the design with new name and/or new script as specified and returns the updated design definition.

Authorizations:
path Parameters
id
required
integer <int32>
query Parameters
includeScript
boolean

Whether to include the design content.

Request Body schema: application/vnd.adobe.target.v1+json
name
required
string <= 250 characters

Unique name of the design.

script
required
string <= 65000 characters

Velocity template containing at least one entity object. Velocity Engine 1.7 is supported.

Responses

200

Successful request with updated design resource in response

Request samples

application/vnd.adobe.target.v1+json
Copy
Expand all Collapse all
{
  • "name": "Landing Page",
  • "script": "name = $entity1.name<br/> details= $entity1.details <table>\n <tr>\n <td>\n <a href=\"$entity1.pageUrl\">\n <img src=\"$entity1.thumbnailUrl\"/>\n <br/>$profile\n <br/> $token\n <br/>$url\n </a>\n </td>\n <td>\n <a href=\"$entity2.pageUrl\">\n <img src=\"$entity2.thumbnailUrl\"/> \n <br/>$entity2.name\n <br/>$entity2.message\n <br/> $entity2.value\n </a>\n </td>\n <td>\n <a href=\"$entity3.pageUrl\">\n <img src=\"$entity3.thumbnailUrl\"/> \n <br/>$entity3.name\n <br/>$entity3.message\n <br/> $entity3.value\n </a>\n </td>\n </tr>\n</table>"
}

Response samples

application/vnd.adobe.target.v1+json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "id": 1,
  • "name": "Landing Page",
  • "script": "<table>\n <tr>\n <td>\n <a href=\"$entity1.pageUrl\">\n <img src=\"$entity1.thumbnailUrl\"/>\n <br/>$profile\n <br/> $token\n <br/>$url\n </a>\n </td>\n <td>\n <a href=\"$entity2.pageUrl\">\n <img src=\"$entity2.thumbnailUrl\"/> \n <br/>$entity2.name\n <br/>$entity2.message\n <br/> $entity2.value\n </a>\n </td>\n <td>\n <a href=\"$entity3.pageUrl\">\n <img src=\"$entity3.thumbnailUrl\"/> \n <br/>$entity3.name\n <br/>$entity3.message\n <br/> $entity3.value\n </a>\n </td>\n </tr>\n</table>"
}

Delete design

delete /designs/{id}

Adobe I/O gateway

https://mc.adobe.io/{tenantId}/target/recs/designs/{id}

Deletes the design referenced by the given ID.

Authorizations:
path Parameters
id
required
integer <int32>

Responses

200

Successful request with deleted design resource in response

Response samples

application/vnd.adobe.target.v1+json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "id": 1,
  • "name": "Landing Page",
  • "script": "<table>\n <tr>\n <td>\n <a href=\"$entity1.pageUrl\">\n <img src=\"$entity1.thumbnailUrl\"/>\n <br/>$profile\n <br/> $token\n <br/>$url\n </a>\n </td>\n <td>\n <a href=\"$entity2.pageUrl\">\n <img src=\"$entity2.thumbnailUrl\"/> \n <br/>$entity2.name\n <br/>$entity2.message\n <br/> $entity2.value\n </a>\n </td>\n <td>\n <a href=\"$entity3.pageUrl\">\n <img src=\"$entity3.thumbnailUrl\"/> \n <br/>$entity3.name\n <br/>$entity3.message\n <br/> $entity3.value\n </a>\n </td>\n </tr>\n</table>"
}

Validate design

post /designs/validate

Adobe I/O gateway

https://mc.adobe.io/{tenantId}/target/recs/designs/validate

Validates a design by verifying the correctness of the script. If its correct, it returns number of entity objects used in the script; otherwise it returns the validation error.

Note this POST request does not create any resource. The endpoint is not a resource but rather it is simply a method to validate the design in request payload..

Authorizations:
Request Body schema: application/vnd.adobe.target.v1+json
name
required
string <= 250 characters

Unique name of the design.

script
required
string <= 65000 characters

Velocity template containing at least one entity object. Velocity Engine 1.7 is supported.

Responses

200

Design resource validated with validation result in response

Request samples

application/vnd.adobe.target.v1+json
Copy
Expand all Collapse all
{
  • "name": "Landing Page",
  • "script": "name = $entity1.name<br/> details= $entity1.details <table>\n <tr>\n <td>\n <a href=\"$entity1.pageUrl\">\n <img src=\"$entity1.thumbnailUrl\"/>\n <br/>$profile\n <br/> $token\n <br/>$url\n </a>\n </td>\n <td>\n <a href=\"$entity2.pageUrl\">\n <img src=\"$entity2.thumbnailUrl\"/> \n <br/>$entity2.name\n <br/>$entity2.message\n <br/> $entity2.value\n </a>\n </td>\n <td>\n <a href=\"$entity3.pageUrl\">\n <img src=\"$entity3.thumbnailUrl\"/> \n <br/>$entity3.name\n <br/>$entity3.message\n <br/> $entity3.value\n </a>\n </td>\n </tr>\n</table>"
}

Response samples

application/vnd.adobe.target.v1+json
Copy
Expand all Collapse all
{
  • "entityCount": 0,
  • "valid": false,
  • "errors":
    [
    ]
}

Entities

Entities refer to the items you want to recommend. Entities can be anything such as products, content (such as articles, slide shows, images, movies, and TV shows), job listings, restaurants, and so forths

Save entities

post /entities

Adobe I/O gateway

https://mc.adobe.io/{tenantId}/target/recs/entities

Creates entities, updates if present, with the given entity details and returns the numbers of entities rejected, and created or updated. Entities can be rejected if entity details do not conform to the schema. More info.

Note this POST request does not create a singular resource. The endpoint is not a resource but rather it is simply a method to save multiple entities specified in request payload.

Authorizations:
Request Body schema: application/vnd.adobe.target.v1+json
entities
required
Array of object non-empty

Responses

200

Successful request with entity batch update result in response

Request samples

application/vnd.adobe.target.v1+json
Copy
Expand all Collapse all
{
  • "entities":
    [
    ]
}

Response samples

application/vnd.adobe.target.v1+json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "rejected": 0,
  • "inserted/updated": 1
}

Delete entities

delete /entities

Adobe I/O gateway

https://mc.adobe.io/{tenantId}/target/recs/entities

Deletes entities referenced by the given IDs. If no ID is given, all entities in the given environment are deleted. If no environment ID is given, entities will be deleted from all environments. Use this with caution!

Note this DELETE request does not delete a singular resource. The endpoint is not a resource but rather it is simply a method to delete multiple entities specified in request payload.

Authorizations:
query Parameters
ids
Array of string

List of entity IDs. If not set, all entities will be deleted.

environment
number <double>

ID of an environment. If not set, entities will be deleted from all environments.

Responses

200

Successful request with entity batch delete result in response

Response samples

application/vnd.adobe.target.v1+json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "operation": "Delete by client requested."
}

Get entity

get /entities/{id}

Adobe I/O gateway

https://mc.adobe.io/{tenantId}/target/recs/entities/{id}

Gets entity with the given ID from default environment. To retrieve entity from a specific environment, environmentId request parameter can be used.

Authorizations:
path Parameters
id
required
string <= 1000 characters
query Parameters
environmentId
integer <int64>

Responses

200

Successful request with entity resource in response

Response samples

application/vnd.adobe.target.v1+json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "name": "Rotisserie Chicken",
  • "id": "item1",
  • "environment": 4227,
  • "categories":
    [
    ],
  • "attributes":
    {
    }
}

Promotions

Promotion is a special type of criteria that includes promoted items in your recommendation design. Item recommendation by promotions use available slots in the design and take precedence over criteria results and backup recommendations.

List promotions

get /promotions

Adobe I/O gateway

https://mc.adobe.io/{tenantId}/target/recs/promotions

List all available promotions.

Authorizations:
query Parameters
offset
integer <int32> (offset)

Number of resources to skip from start in the server list. If not specified, the response list will start from first available resource.

limit
integer <int32> (limit)

Number of resources to request. If not specified, the response will include all available resources.

Responses

200

Successful request with list of promotion resources in response

Response samples

application/vnd.adobe.target.v1+json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "offset": 0,
  • "limit": 2147483647,
  • "total": 2,
  • "list":
    [
    ]
}

Create promotion

post /promotions

Adobe I/O gateway

https://mc.adobe.io/{tenantId}/target/recs/promotions

Creates a new promotion as specified by the settings and configuration provided and returns the newly created promotion definition.

Authorizations:
Request Body schema: application/vnd.adobe.target.v1+json
name
required
string <= 250 characters

Unique name of the promotion.

type
required
string
Value:"EXTERNAL"

Type of promotion. Currently only external promotions can be created, in which promoted items do not originate from any of the criteria specified in the current recommendation activity.

key
string
Enum:"CURRENT" "LAST_PURCHASED" "LAST_VIEWED" "MOST_VIEWED" "PROFILE_ATTRIBUTE"

Promotion key. Values:

  • CURRENT: The currently viewed item.
  • LAST_VIEWED: The last viewed item.
  • LAST_PURCHASED: The last purchased item.
  • MOST_VIEWED: The most viewed item. The recommendations are determined by items that have been most viewed. The score is determined by recency/frequency: 10 points for first item view, 5 points for every subsequent view, all points are halved after the session ends.
  • PROFILE_ATTRIBUTE: Profile attribute.
attribute
string^(profile\.|user\.).+

Applicable when key is PROFILE_ATTRIBUTE. This is the profile attribute.

schedule
object

Time duration for which promotion should be applied.

order
object
configuration
object

Applicable only when rules are empty and type is not INTERNAL. It contains the relevant collection for promotion items.

rules
Array of object (RestInclusionMatcher)

Responses

201

Promotion resource created with resource definition in response

Request samples

application/vnd.adobe.target.v1+json
Copy
Expand all Collapse all
{
  • "name": "Hiking shoes summer promotion",
  • "type": "INTERNAL",
  • "schedule":
    {
    },
  • "order":
    {
    },
  • "configuration": 1,
  • "rules":
    [
    ]
}

Response samples

application/vnd.adobe.target.v1+json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "id": 1,
  • "name": "Hiking shoes summer promotion",
  • "type": "INTERNAL",
  • "schedule":
    {
    },
  • "order":
    {
    },
  • "configuration": 1,
  • "rules":
    [
    ]
}

Get promotion

get /promotions/{id}

Adobe I/O gateway

https://mc.adobe.io/{tenantId}/target/recs/promotions/{id}

Gets the promotion with the given ID.

Authorizations:
path Parameters
id
required
integer <int32>

Responses

200

Successful request with promotion resource in response

Response samples

application/vnd.adobe.target.v1+json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "id": 1,
  • "name": "Hiking shoes summer promotion",
  • "type": "INTERNAL",
  • "schedule":
    {
    },
  • "order":
    {
    },
  • "configuration": 1,
  • "rules":
    [
    ]
}

Edit promotion

put /promotions/{id}

Adobe I/O gateway

https://mc.adobe.io/{tenantId}/target/recs/promotions/{id}

Updates the promotion with the new settings and configuration as specified and return the updated promotion definition.

Authorizations:
path Parameters
id
required
integer <int32>
Request Body schema: application/vnd.adobe.target.v1+json
name
required
string <= 250 characters

Unique name of the promotion.

type
required
string
Value:"EXTERNAL"

Type of promotion. Currently only external promotions can be created, in which promoted items do not originate from any of the criteria specified in the current recommendation activity.

key
string
Enum:"CURRENT" "LAST_PURCHASED" "LAST_VIEWED" "