Update Reward's Thumbnail

PUT 
/reward/:rewardId/thumbnail

Update Reward's Thumbnail

Request

Path Parameters

rewardId stringrequired

The rewardId to update

multipart/form-data

Body

Reward thumbnail image file

thumbnail binary

Responses

200

Reward successfully updated

application/json

Schema

Schema

userRewardCount integer

Number of times this reward has been redeemed.

expiresAt date-timenullable

Expiration date for special rewards

myUserRewardCount integer

Number of times this reward has been redeemed by the current user.

data stringnullable

Additional JSON metadata for triggers, actions or general easy-access data

userRewardsLimit integer

Maximum allowed number of times for the reward to be redeemed by a single user

requiredPoints integer

Possible values: <= 1000000

Points required to claim the reward

description string

Detailed description of the reward

rankOrder integer

The order in which the reward should be displayed

thumbnail urinullable

Optional URL for the reward's thumbnail image.

rewardTypeId rewardTypeId (string)required

Unique identifier for RewardType

projectId stringrequired

ID of the project associated with the reward

createdAt date-time

Time representation of entity creation

maxClaims integernullable

Maximum number of times this reward can be redeemed.

name rewardName (string)required

Possible values: <= 32 characters

Name of the reward

id rewardId (string)

Unique identifier for Reward

Example (from schema)

{
  "userRewardCount": 1,
  "expiresAt": "2025-01-01T09:00:00.00Z",
  "myUserRewardCount": 2,
  "data": "{\"criteria\": \"complete_all_adventure_quests\", \"icon\": \"explorer_badge_icon.png\"}",
  "userRewardsLimit": 3,
  "requiredPoints": 10,
  "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!\"]}",
  "rankOrder": 1,
  "thumbnail": "https://file.playmakers.co/r15Y7T4sM/r15Y7T4sM_thumbnail.png",
  "rewardTypeId": "R3b19Z1n",
  "projectId": "pGdouyKfY",
  "createdAt": "2024-01-01T09:00:00.00Z",
  "maxClaims": null,
  "name": "Amazon gift card",
  "id": "r3b19Z1n"
}

400

Bad Request

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Bad Request"
}

401

Unauthorized

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Unauthorized access"
}

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Forbidden access"
}

404

NotFound

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "A mandatory item was not found"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Internal Server Error"
}

default

Unexpected error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "An unexpected error occured"
}

Loading...