Update a reward by ID
PUT/reward/:rewardId
Update a reward by ID
Request
Path Parameters
The unique identifier for the reward to update
- application/json
Body
Data for updating the reward
Possible values: <= 32 characters
Name of the reward
Expiration date for special rewards
Maximum amount of times the reward can be claimed globally
Thumbnail image for the reward
Possible values: <= 1000000
Points required to claim the reward
Detailed description of the reward
Additional JSON metadata for triggers, actions, or general easy-access data
Responses
- 200
- 403
- 404
- 500
Reward updated successfully
- application/json
- Schema
- Example (from schema)
Schema
Optional URL for the reward's thumbnail image.
ID of the project associated with the reward
Number of times this reward has been redeemed by the current user.
Unique identifier for Reward
Maximum allowed number of times for the reward to be redeemed by a single user
Number of times this reward has been redeemed.
Additional JSON metadata for triggers, actions or general easy-access data
Possible values: <= 1000000
Points required to claim the reward
The order in which the reward should be displayed
Detailed description of the reward
Time representation of entity creation
Unique identifier for RewardType
Possible values: <= 32 characters
Name of the reward
Expiration date for special rewards
Maximum number of times this reward can be redeemed.
{
"thumbnail": "https://file.playmakers.co/r15Y7T4sM/r15Y7T4sM_thumbnail.png",
"projectId": "pGdouyKfY",
"myUserRewardCount": 2,
"id": "r3b19Z1n",
"userRewardsLimit": 3,
"userRewardCount": 1,
"data": "{\"criteria\": \"complete_all_adventure_quests\", \"icon\": \"explorer_badge_icon.png\"}",
"requiredPoints": 10,
"rankOrder": 1,
"description": "{\"pre\":[\"Are you sure you want to claim this reward?\"],\"short\":\"A 20$ gift card for my followers\",\"post\":[\"Your reward has been redeemed successfully!\"]}",
"createdAt": "2024-01-01T09:00:00.00Z",
"rewardTypeId": "R3b19Z1n",
"name": "Amazon gift card",
"expiresAt": "2025-01-01T09:00:00.00Z",
"maxClaims": null
}
Forbidden
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"error": "string"
}
{
"error": "Forbidden access"
}
NotFound
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"error": "string"
}
{
"error": "A mandatory item was not found"
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"error": "string"
}
{
"error": "Internal Server Error"
}