Parameter | Type | Description | Request | Response | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | PUT | POST | DELETE | GET | PUT | POST | DELETE | |||||
entityId | String | Achievement id or Contest id | Yes | Yes | Yes | Yes | Yes | |||||
entityType | String | Can be achievement or contest | Yes | Yes | Yes | Yes | Yes | |||||
rewardRank | String | If used in the context of contest this will associate with the rank of the leaderboard | Yes | Yes | Yes | Yes | Yes | |||||
rewardName | String | The name of a reward | Yes | Yes | Yes | Yes | Yes | |||||
value | Double | Numerical value of the reward that will be issued based on the reward type | Yes | Yes | Yes | Yes | Yes | |||||
rewardType | String | A unique identifier of the Reward Type | Yes | Yes | Yes | Yes | Yes | |||||
description | String | The description of a Reward | Yes | Yes | Yes | Yes | Yes | |||||
delay | Integer | Delay of issuing a reward in minutes | Yes | Yes | Yes | Yes | Yes | |||||
memberAcknowledgmentRequired | Boolean | Requires member acknowledgment to claim a reward. If set to True reward will not be automatically issued | Optional | Optional | Yes | Yes | Yes | |||||
metadata | Array [Object] | A list of Metadata | Yes | Yes | Yes | Yes | Yes | |||||
accountId | String | Unique identifier of your account | Yes | Yes | Yes | |||||||
pointInTime | DateTime | Reward is available until a specific point in time | Optional | Optional | Yes | Yes | Yes | |||||
period | Integer | Reward available for a period of time from issuing | Optional | Optional | Yes | Yes | Yes | |||||
created | DateTime | ISO8601 timestamp for when a Reward was created. All records are stored in UTC time zone. | Yes | Yes | Yes | |||||||
id | String | Unique system identifier of a Reward | Yes | Yes | Yes | |||||||
translations | Object | It is a key-value pair of language code and a list of translations. The translatable fields are "rewardName" and "description". Translation model | Optional | Optional | Yes | Yes | Yes |