Engage Content Rules Management API

Overview

The Engage Content Rules Management API allows an organization to create and manage content rules for their site. Content rules can be used to pass a seed category for product recommendations to visitors who match on a segment and context, such as a placement on the home page.

Note: The Context and/or Segments need to be created in order to use this API with the ContextID or SegmentID.

Copy

https://{environment}.richrelevance.com/engage/api/engageRules/{version}

Note: The URL requires the environment (gateway, staging-gateway or qa-gateway), version and parameter(s) to function properly. See below for more information on example URL requests.

Description: Provide updates to the user profile in the user profile service (currently only implements opt out).

Parameters

Name	Required or Optional	Description
externalId	Optional	The generated ID of the rule. Leave blank for new rules.
name	Optional	The name of the rule
contextId	Optional	The ID of the context
segmentId	Optional	The ID of the segment(s)
enableQA	Optional	Is the rule applicable in the QA environment
enableProd	Optional	Is the rule applicable in the Production environment
startTime	Optional	The time the rule becomes active
endTime	Optional	The time the rule expires.
contentType	Optional	The type of the content to be included via the rule
engageContent	Optional	Should match the contentType value
personalizedRecommendation	Optional	Should Product Recommendations be personalized. Default is false
categoryExternalId	Optional	The category seed to be used for Product Recommendations displayed as part of this rule
brandExternalID	Optional	The brand seed to be used for Product Recommendations displayed as part of this rule
targetCartValueCents	Optional	The target Cart Value in cents
content	Optional
priority	Optional	Priority of the rule, expressed as an integer between 0 and 10. Five (5) is the default.

Labels

Name	Required or Optional	Description
labelType	Optional	Generated ID for the label
label	Optional	The value of the label

Sample

Copy

value: "{\n  \"id\": 0,\n  \"label\": \"some label\"\n}"

Tag Type

Name	Required or Optional	Description
id	Optional	Generated ID for the tag
label	Optional	The value of the tag

Sample

Copy

value: "{\n  \"id\": 0,\n  \"label\": \"some label\"\n}"

Content Type

Name	Required or Optional	Description
id	Optional	Generated ID for the tag
productType	Optional
exertnalId	Optional
title	Optional
startDate	Optional
endDate	Optional
recommendable	Optional
findable	Optional
attributes	Optional
label	Optional	The value of the tag

Sample

Copy

value: "{\n    \"AREA\": \"DESTAQUE\",\n    \"CONTENT_ALT\": \"OFERTA\"\
            ,\n    \"CONTENT_IMAGE\": \"https://images-americanas.b2w.io/spacey/2018/04/10/DiaDasMaes__SITE_banner-quadruplo.png\"\
            ,\n    \"CONTENT_IMAGE_M\": \"https://images-americanas.b2w.io/spacey/2018/04/10/DiaDasMaes__SITE_banner-quadruplo.png\"\
            ,\n    \"CONTENT_URL\": \"https://www.americanas.com.br/hotsite/dia-das-maes\"\
            ,\n    \"r_recommend\": \"true\",\n    \"start_time\": \"00:00\"\n}"

Name	Required or Optional	Description
regionalAttributes	Optional
totalMaxViews	Optional
startDateTime	Optional
totalMaxViews	Optional
resetViews	Optional
startDateTime	Optional
endDateTime	Optional
trimmedName	Optional
previewImageURL	Optional
previewImageURL	Optional
tags	Optional

Sample

Copy

value: "{\n\t\t\t\"id\": 20308744177,\n\t\t\t\"productType\": 2,\n\t\t\t\"externalId\"\
        : \"content__12\",\n\t\t\t\"title\": \"Banner ABAIXO 3\",\n\t\t\t\"startDate\"\
        : \"2018-04-05\",\n\t\t\t\"endDate\": null,\n\t\t\t\"recommendable\": true,\n\
        \t\t\t\"findable\": false,\n\t\t\t\"attributes\": {\n\t\t\t\t\"AREA\": \"\
        DESTAQUE\",\n\t\t\t\t\"CONTENT_ALT\": \"OFERTA\",\n\t\t\t\t\"CONTENT_IMAGE\"\
        : \"https://images-americanas.b2w.io/spacey/2018/04/10/DiaDasMaes__SITE_banner-quadruplo.png\"\
        ,\n\t\t\t\t\"CONTENT_IMAGE_M\": \"https://images-americanas.b2w.io/spacey/2018/04/10/DiaDasMaes__SITE_banner-quadruplo.png\"\
        ,\n\t\t\t\t\"CONTENT_URL\": \"https://www.americanas.com.br/hotsite/dia-das-maes\"\
        ,\n\t\t\t\t\"r_recommend\": \"true\",\n\t\t\t\t\"start_time\": \"00:00\"\n\
        \t\t\t},\n\t\t\t\"regionalAttributes\": [],\n\t\t\t\"totalMaxViews\": -1,\n\
        \t\t\t\"resetViews\": false,\n\t\t\t\"startDateTime\": \"2018-04-05T00:00\"\
        ,\n\t\t\t\"endDateTime\": null,\n\t\t\t\"trimmedName\": \"Banner ABAIXO 3\"\
        ,\n\t\t\t\"active\": true,\n\t\t\t\"previewImageURL\": \"https://images-americanas.b2w.io/spacey/2018/04/10/DiaDasMaes__SITE_banner-quadruplo.png\"\
        ,\n\t\t\t\"tags\": [{\n\t\t\t\t\"id\": 196254,\n\t\t\t\t\"externalId\": \"\
        3\"\n\t\t\t}]\n\t\t}"