Get a rewardType by ID
GET/rewardType/:rewardTypeId
Get a rewardType by ID
Request
Path Parameters
rewardTypeId rewardTypeIdrequired
The unique identifier for the rewardType
Responses
- 200
- 404
- 500
rewardType retrieved successfully
- application/json
- Schema
- Example (from schema)
Schema
category stringrequired
Category of the reward type.
data string
JSON string containing metadata, actions, and functions associated with the reward.
description string
Detailed description of the reward type.
id rewardTypeId (string)
Unique identifier for RewardType
title stringrequired
Title of the reward type.
name stringrequired
Name of the reward type.
thumbnail stringnullable
URL of the thumbnail for the reward type.
singleUse boolean
Boolean to specify if the rewardType can reeemed once.
createdAt date-time
The date and time when the reward type was created.
{
"category": "Digital Goods",
"data": "{\"validity\": \"30 days\", \"features\": [\"no ads\", \"exclusive content\"]}",
"description": "This reward gives you access to premium features for one month.",
"id": "R3b19Z1n",
"title": "One Month Premium Subscription",
"name": "Premium Subscription",
"thumbnail": "https://example.com/thumbnail.png",
"singleUse": "true",
"createdAt": "2023-10-23T10:00:00Z"
}
NotFound
- application/json
- Schema
- Example (from schema)
- Example
Schema
error string
{
"error": "string"
}
{
"error": "A mandatory item was not found"
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Example
Schema
error string
{
"error": "string"
}
{
"error": "Internal Server Error"
}
Loading...