To include rich text content metadata in a reward, use the richContentRO
field in the languageSpecificInfo
section of the reward creation API. The content
field can contain HTML-formatted text, and the isEnabled
field indicates whether the rich text content is active.
Note
- The system validates rich content to ensure it does not exceed character limits (50,000 characters) and does not contain invalid HTML tags (e.g., JavaScript tags).
- Rich content can be marked as
isDefault
orisActive
, allowing for default content to be used when no specific content is provided, and active content to be displayed to users.- When the
isMandatory
field is set totrue
for rich text content, and no specific rich text content is mapped to the reward, the system will automatically use the default value defined for the rich text content.
Use Case
Rich text content allows brands to include HTML-formatted text in rewards, enabling personalized and visually appealing descriptions, terms, or additional information. This is particularly useful for:
- Detailed Reward Descriptions: Provide in-depth information about the reward, including benefits, usage instructions, or promotional details.
- Custom Terms and Conditions: Display formatted terms and conditions directly within the reward.
- Dynamic Content: Use HTML tags like
<strong>
,<em>
, and<p>
to highlight important information and present reward details in a clear, structured format.
Adding Rich Text Content to reward
Use the richContentRO
field within the languageSpecificInfo
section of the reward creation API to map rich text content to specific languages.
{
"name": "rewardrctesting",
"description": "testreward1",
"startTime": "2025-09-26T20:00:00Z",
"endTime": "2026-10-31T11:59:30Z",
"type": "VOUCHER",
"brandId": "61",
"enabled": true,
"intouchPoints": 500,
"categories": [229],
"redemptionType": "INTOUCH_REWARD",
"intouchSeriesId": "301233",
"geography": [],
"languageSpecificInfo": [
{
"languageCode": "en",
"name": "jogoldnamechange check",
"description": "testreward1",
"enabled": true,
"cardSeries": 123,
"richContentRO": {
"Testing-richtestcontent": {
"content": "hello this is rich content test",
"isEnabled": true
}
}
}
],
"isactive": true
}
Request body parameters
Parameter Name | Data Type | Description |
---|---|---|
languageSpecificInfo.richContentRO | Object | The rich content object for the reward. |
richContentRO.content | String | The HTML-formatted rich text content. |
richContentRO.isEnabled | Boolean | Indicates whether the rich text content is enabled. Supported Values: true or false |
defaultValue | String | Default value if rich text content is not mapped to the reward. Required if isMandatory is set to true |