put https://{host}/api_gateway/rewards/core/v1/brand/richContentMeta/
This API is used to update rich content metadata for rewards within a brand.In addition to updating metadata, you can enable or disable the rich content metadata for a specific reward.
Prerequisites
- Authentication: Basic or OAuth authentication
- Create Rich Text Content Metadata using Create Rich Text Content Meta Data Against Reward
API Specification
URI | /api_gateway/rewards/core/v1/brand/richContentMeta/{RichtextmetaID) |
HTTP Method | PUT |
Pagination | Yes (via pagingDto ) |
API endpoint example
https://{host}/api_gateway/rewards/core/v1/brand/richContentMeta/{RichtextmetaID)
Request Body Parameters
Parameter | Type | Description |
---|---|---|
name * | String | Unique identifier for the rich content metadata (Max: 256 characters). |
description | String | Description of the metadata (Max: 256 characters). |
isMandatory * | Boolean | Whether metadata is mandatory (true or false ). |
isActive | Boolean | Indicates whether the rich content metadata is active or inactive. Set to true to enable or false to disable the metadata.Defaults to true during creation, even if set to false in the request body. |
scope * | Enum | Scope must be set "REWARD" (case-sensitive). |
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. |
Note: If the maximum active rich content limit of 20 is exceeded, the update will fail when enabling true
in Isactive.
Example Request
{
"name": "terms&conditions",
"description": "RC1_desc",
"isMandatory": false,
"isActive": true,
"scope": "REWARD"
}
Example Response
{
"id": 4,
"name": "terms&conditionsupdated",
"description": "RC1_desc",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"createdBy": 75161973,
"createdOn": 1743397847133,
"lastUpdatedBy": 75161973,
"lastUpdatedOn": 1743397847133
}
Response Parameters
Parameter Name | Data Type | Description |
---|---|---|
id | Long | Unique identifier for metadata. |
name | String | Metadata name. |
description | String | Metadata description. |
isMandatory | Boolean | Whether metadata is mandatory. |
isActive | Boolean | Status of metadata. |
scope | Enum | Scope of the metadata. |
defaultValue | String | Default assigned value. |
createdBy | Long | User ID of the creator. |
createdOn | Long | Creation timestamp. Timestamps are in UTC (milliseconds since epoch). |
lastUpdatedBy | Long | User ID of the last updater. |
lastUpdatedOn | Long | Last update timestamp . Timestamps are in UTC (milliseconds since epoch). |
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. |