Adding Rich Text Content field for Reward

post https://{host}.api.capillarytech.com/v2/organization/api_gateway/rewards/core/v1/reward/create

You can use the languageSpecificInfo object in “Create Reward API” to include rich text content metadata in a reward. The content field can contain HTML-formatted text, and the isEnabled field indicates whether the rich text content is active.

Prerequisites

Create Rich Text Content Metadata using Create Rich Text Content Meta Data Against Reward
Ensure that the rich text content is active by setting the isEnabled field to true. If it is not set, you can update it through Update Rich Text Content Metadata Against Reward.

Use Case

Requirement

Suppose a brand wants to include reward-related terms and conditions within the reward itself and these details should support plain HTML, enabling the use of headings, lists, line breaks, and other basic tags to ensure the content is well-structured, readable, and visually consistent across platforms.

Solution

To achieve this you can create terms and condition rich text using Create Rich Text and link the same during the Creation of Reward.

Adding Rich Text Content to Reward

Use the languageSpecificInfo section of the reward creation API to map rich text content to specific languages.

{
    "name": "Golden2",
    "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": {
                "terms&conditions": {
                    "content": "RC2_desc",
                    "isEnabled": true
                }
            }
        }
    ],
    "isactive": true
}{
    "name": "Golden3",
    "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": {
                "terms&conditions-2": {
                    "content": "RC2_desc",
                    "isEnabled": true
                }
            }
        }
    ],
    "isactive": true
}

{
    "name": "rewardname",
    "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": "rewardname",
            "description": "testreward1",
            "enabled": true,
            "cardSeries": 123,
            "richContentRO": {
                "termsAndConditionsenglish": {
                    "content": "<h1>Terms and Conditions</h1><p>These are the terms and conditions...</p>",
                    "isEnabled": true
                }
            }
        },
        {
            "languageCode": "fr",
            "name": "rewardname",
            "description": "testreward1",
            "enabled": true,
            "cardSeries": 123,
            "richContentRO": {
                "termsAndConditionsfrench": {
                    "content": "<h1>Conditions Générales</h1><p>Voici les conditions générales...</p>",
                    "isEnabled": 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 for the specific reward. Supported Values: `true` or `false`
`defaultValue`	String	The default value is shown when rich text content is unavailable for a specific reward. - Required: Only if `isMandatory` is set to `true`. - Optional: If `isMandatory` is false. - Max Length: 50,000 characters.

Error Handling

HTTP Status Code	Resolution
400 - Invalid request parameters.	Ensure all required parameters are included in the request body.
400 - value is not one of declared Enum	Ensure provided Enum field matches one of the supported values.
400 - `defaultValue` is required when isMandatory is true.	Ensure `defaultValue` is not set to null, when `isMandatory` is set to true.
500 - Internal server error.	Retry the request after a short delay. The issue may be temporary.

Language

Credentials

OAuth2

URL

Click Try It! to start a request and see the response here!