Parameter | Type | Description | Request | Response | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | PUT | POST | DELETE | GET | PUT | POST | DELETE | |||||
accountId | String | Unique identifier of your account | Yes | Yes | Yes | |||||||
memberId | String | A unique identifier of a member | Yes | Yes | Yes | Yes | Yes | |||||
reward | Object | Reward model | Yes | Yes | Yes | Yes | Yes | |||||
claimed | Boolean | has the award been claimed or not | Yes | Yes | Yes | Yes | Yes | |||||
entityType | String | The type of entity this Award relates to (Contest or Achievement) | Yes | Yes | Yes | Yes | Yes | |||||
entityId | String | The Id of the contest or achievement related to this Award | Yes | Yes | Yes | Yes | Yes | |||||
*pointInTime | DateTime | Claimable until a specified point in time. ISO8601 timestamp | Optional | Optional | Yes | Yes | Yes | |||||
*period | Integer | Claimable duration in minutes, this value will set the controls until when the award is claimable | Optional | Optional | Yes | Yes | Yes | |||||
created | DateTime | ISO8601 timestamp for when the Award was created. All records are stored in UTC time zone. | Yes | Yes | Yes | |||||||
id | String | Unique system identifier of an Award | Yes | Yes | Yes | |||||||
*There can only be one time definition used for claim period either "pointInTime" or "period"