Create a new reward
POST/reward
Create a new reward
Request
- application/json
Body
Data for creating a new reward
Detailed description of the reward
Optional URL for the reward's thumbnail image.
Additional JSON metadata for triggers, actions or general easy-access data
Maximum allowed number of times for the reward to be redeemed by a single user
Unique identifier for RewardType
ID of the project associated with the reward
Expiration date for special rewards
The order in which the reward should be displayed
Unique identifier for Reward
Possible values: <= 32 characters
Name of the reward
Maximum number of times this reward can be redeemed.
Possible values: <= 1000000
Points required to claim the reward
Responses
- 201
- 400
- 401
- 403
- 404
- 500
- default
Reward successfully created
- application/json
- Schema
- Example (from schema)
Schema
Detailed description of the reward
Optional URL for the reward's thumbnail image.
Additional JSON metadata for triggers, actions or general easy-access data
Maximum allowed number of times for the reward to be redeemed by a single user
Unique identifier for RewardType
ID of the project associated with the reward
Expiration date for special rewards
The order in which the reward should be displayed
Unique identifier for Reward
Possible values: <= 32 characters
Name of the reward
Number of times this reward has been redeemed by the current user.
Maximum number of times this reward can be redeemed.
Number of times this reward has been redeemed.
Time representation of entity creation
Possible values: <= 1000000
Points required to claim the reward
{
"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!\"]}",
"thumbnail": "https://file.playmakers.co/r15Y7T4sM/r15Y7T4sM_thumbnail.png",
"data": "{\"criteria\": \"complete_all_adventure_quests\", \"icon\": \"explorer_badge_icon.png\"}",
"userRewardsLimit": 3,
"rewardTypeId": "R3b19Z1n",
"projectId": "pGdouyKfY",
"expiresAt": "2025-01-01T09:00:00.00Z",
"rankOrder": 1,
"id": "r3b19Z1n",
"name": "Amazon gift card",
"myUserRewardCount": 2,
"maxClaims": null,
"userRewardCount": 1,
"createdAt": "2024-01-01T09:00:00.00Z",
"requiredPoints": 10
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"error": "string"
}
{
"error": "Bad Request"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"error": "string"
}
{
"error": "Unauthorized access"
}
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"
}
Unexpected error
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"error": "string"
}
{
"error": "An unexpected error occured"
}